PluginComponent created when the ActivityPlugin is loaded and createComponent is called. Defines the lifecycle and main menu actions for an activity.

Hierarchy

Properties

isActive?: boolean

Optional activity state of this component. Initial component state should be inactive (false or undefined).

Methods

  • Called if this instance is no longer in use. Should be used to clean-up resources.

    Returns Promise<void>

  • Will be called everytime the main menu gets opened.

    Returns null | readonly MenuAction[]

  • Can be implemented to make preparations before the activity gets stopped and disposed. If pCancelable is true and the promise resolves with false, the activity stop will be canceled. Otherwise true should be returned.

    Parameters

    • pCancelable: boolean

    Returns Promise<boolean>

  • Optional activity state handling for this component. E.g. can be used to disable/enable event handling. Will be set from the component host to activate or deactivate the component. Initial component state should be inactive (false or undefined).

    Parameters

    • pActive: boolean

    Returns Promise<void>

Generated using TypeDoc