Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
ClassificationScriptBaseabstract

Base class for document classification scripts. More...

Inheritance diagram for ClassificationScriptBase:
ScriptBase

Public Member Functions

abstract bool IsMatch (SCDocument document, string documentType)
 Indicates if the selected document should be classified to this documenttype. 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 document classification scripts.

Member Function Documentation

◆ IsMatch()

abstract bool IsMatch ( SCDocument  document,
string  documentType 
)
pure virtual

Indicates if the selected document should be classified to this documenttype.

Parameters
documentDocument to classify
documentTypeDocumenttype to check
Returns
True if this document must be classified to this document type