Package html-api
Scripting API reference
This is the reference documentation of the Scripting Application Programming Interface (API).
It lists all the types of objects (classes, enums, types, methods etc.) that are available in the Job, Indexing, Global and other scripts. Those objects are either passed as input parameters to script functions, or are available as global objects.
Refer to the Developer's Guide for the available Scripting Functions in each Script (Global, Job, Indexing etc.) along with documentation about function parameters, return types, when they get executed and how to use them. The specific details and signatures about all the types that are referred there, are listed in this documentation.
For more information and details about a type, click on the type name in the navigation list on the side, or click the search button at the top to search by name.
For example, the function batchCreated(batch) of the Job script receives the batch input parameter that is of type IBatch. In order to see all available methods, properties, details and information about this type, refer to the IBatch page of this documentation.
Runtime Environments
Some scripts may run on different components with different Runtime Contexts. Here are the available Contexts:
- Java Client
- HTML Client
- Import Service
- Core Service
All the available types have the same behaviour and the same properties in all of runtime contexts, with some specific exceptions. Those special cases are marked and documented by an appropriate label that indicates any difference for a Runtime Context. Hovering the mouse upon those labels a tooltip gets displayed with information about the differences of that specific context.