Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
FileImportScriptBaseabstract

Base class for all file import scripts. More...

Inheritance diagram for FileImportScriptBase:
ScriptBase

Public Member Functions

abstract List< SCFileImportBatch > ImportFiles (string folder)
 Imports a collection of files. 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 file import scripts.

Member Function Documentation

◆ ImportFiles()

abstract List<SCFileImportBatch> ImportFiles ( string  folder)
pure virtual

Imports a collection of files.

Parameters
folderImport folder
Returns
SCProcess batch object with optional documents and importfields