ScriptManagerClient

Client-side representation of the ScriptManager

Extends

Constructor

new ScriptManagerClient()

Source:

Methods

(async) attach(name) → {Promise.<SharedScript>}

Description:

  • Attach to a script.

Source:
Overrides:
Parameters:
Name Type Description
name String

Name of the script
Returns:
Type
Promise.<SharedScript>

(async) getCollection() → {Promise.<SharedStateCollection>}

Description:

  • Return the SharedStateCollection of all the scripts underlying share states. Provided for build and error monitoring purposes. Can also be used to maintain a list of existing script, e.g. in a drop-down menu

    If you want a full featured / executable Script instance, use the attach instead.

Source:
Overrides:
Returns:
Type
Promise.<SharedStateCollection>

getList() → {Array.<String>}

Description:

  • Returns the list of all available scripts.

Source:
Overrides:
Returns:
Type
Array.<String>

onUpdate(callback, executeListeneropt)

Description:

  • Register callback to execute when a script is created or deleted.

Source:
Overrides:
Parameters:
Name Type Attributes Default Description
callback function

Function to execute
executeListener Boolean <optional>
 false

If true, execute the given callback immediately.