Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Data Fields
ActivityScriptBaseabstract

Base class for any scripted activity. More...

Inheritance diagram for ActivityScriptBase:
ScriptBase

Public Member Functions

abstract bool Execute (SCProcess batch, Dictionary< string, string > properties)
 Execute this activity on the current batch. More...
 

Data Fields

Func< string, string > GetValueAsPath
 Get value of any existing internal meta data field "{CESomeValue}" and remove invalid file path characters. More...
 
Func< string, string > GetValueAsText
 Get value of any existing internal meta data field "{CESomeValue}". More...
 
- 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...
 

Additional Inherited Members

- 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 any scripted activity.

Member Function Documentation

◆ Execute()

abstract bool Execute ( SCProcess  batch,
Dictionary< string, string >  properties 
)
pure virtual

Execute this activity on the current batch.

Parameters
batchThe batch object to process
propertiesKey Value collection of configured properties
Returns
True if processing was successfull, false otherwise

Field Documentation

◆ GetValueAsPath

Func<string, string> GetValueAsPath

Get value of any existing internal meta data field "{CESomeValue}" and remove invalid file path characters.

◆ GetValueAsText

Func<string, string> GetValueAsText

Get value of any existing internal meta data field "{CESomeValue}".