Octobox API  4.1.0
Octobox Scripting API
Public Member Functions
FileInsertionDownloadScriptBaseabstract

Base class for all script locators. More...

Inheritance diagram for FileInsertionDownloadScriptBase:
ScriptBase

Public Member Functions

abstract string DownloadFile (string uri, string internalPath)
 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

◆ DownloadFile()

abstract string DownloadFile ( string  uri,
string  internalPath 
)
pure virtual

Downloads the file from specified uri.

Parameters
uriUrl or path containing the file to download
internalPathInternal path to save the downloaded file to
Returns
Filename of the downloaded file