Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
ConversionScriptBaseabstract

Base class for all script locators. More...

Inheritance diagram for ConversionScriptBase:
ScriptBase

Public Member Functions

abstract string ConvertFile (string fileName, string newFileName)
 Downloads the file from specified uri. 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

◆ ConvertFile()

abstract string ConvertFile ( string  fileName,
string  newFileName 
)
pure virtual

Downloads the file from specified uri.

Parameters
fileNameFull internal filename of the file to convert
newFileNameFull internal filename of the converted file. Only the extension of this filename may be changed
Returns
The file extension of the converted file