Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
LocatorScriptBaseabstract

Base class for all script locators. More...

Inheritance diagram for LocatorScriptBase:
ScriptBase

Public Member Functions

abstract List< SCAlternative > Execute (List< String > targetText, List< SCDocument > files, bool ignorePageRestrictions, String fileCriteria)
 Executes this script locator. More...
 

Additional Inherited Members

- Data Fields inherited from ScriptBase
Action< string > LogInfo
 Write text to the Octobox logging at information level. More...
 
Action< string > LogMsg
 Write text to the Octobox logging at normal level. More...
 
- Properties inherited from ScriptBase
SCProcess Batch [get, set]
 Batch object containing global values available to all scripts. More...
 
CancellationToken CancellationToken [get, set]
 Cancellation token that can be checked for process cancellation on long running script actions. More...
 
SourceApplications SourceApplication [get, set]
 Application that called this function. More...
 

Detailed Description

Base class for all script locators.

Member Function Documentation

◆ Execute()

abstract List<SCAlternative> Execute ( List< String >  targetText,
List< SCDocument >  files,
bool  ignorePageRestrictions,
String  fileCriteria 
)
pure virtual

Executes this script locator.

Parameters
targetTextText to search in, eg. Subject
filesCollection of documents to search in
ignorePageRestrictionsIndicates if page and zone restrictions should be ignored. eg. when called from Separation or Removal activity
fileCriteriaFile criteria determing which files or attachments when called from a rule matching pattern
Returns
A collection of alternatives