The ActionController is responsible for all Actions-related functionality. Methods inside this controller can be called by window.SDK.action.{method-name}

Hierarchy

  • ActionController

Methods

  • Deprecated

    use the update method instead

    This method renames an action by the id and provided name

    Returns

    Parameters

    • id: string

      the id of a specific action

    • name: string

      the new unique name for the action

    Returns Promise<EditorResponse<null>>

  • Deprecated

    use the update method instead

    This method stores the state of action type errors to the document

    Those errors states can be read back from the usual getters or the onActionsChanged stream

    Returns

    Parameters

    • id: string

      the id of a specific action

    • hasTypeErrors: boolean

      whether there is an action type error

    Returns Promise<EditorResponse<null>>

  • Deprecated

    use the update method instead

    This method updates the script the action uses by the id and provided script

    Returns

    Parameters

    • id: string

      the id of a specific action

    • actionScript: string

      the JavaScript based action script

    Returns Promise<EditorResponse<null>>

Generated using TypeDoc