Interface: StateAPI

StateAPI

API class that is used to control a state.

Example

content.getFeature('state')

Members

(static, readonly) STATUS :String

Enumeration of status.
Type:
  • String
Properties:
Name Type Description
CREATED String Created, means the content is created but before loading widget
INITIALIZED String Initialized
RENDERING String Rendering
RENDERED String Rendered

Methods

getError() → {Error}

Returns the error associated with the state.
Returns:
Type of the canvas content
Type
Error

getStatus() → {StateAPI#STATUS}

Returns the status of the state.
Returns:
Type
StateAPI#STATUS

onChangeError()

Registers the callback method to call when setError is called.

(async) whenStatusChanges(status) → {Promise.<STATUS>}

Resolves when the status changes to an expected status.
Parameters:
Name Type Description
status StateAPI#STATUS
Returns:
Type
Promise.<STATUS>