The ProjectWorkflow plugin manages user restrictions and the project state for the current ProjectEditor. E.g.: The project state may be changed to Ordered when an order is sent.

  • Plugin category = ProjectWorkflow

Hierarchy

Properties

eventWorkflowRestrictionsChanged: ListenableEvent<void, ProjectWorkflow>

Will be triggered every time the workflowRestrictions have changed. Should not be used directly by most plugins. Use ProjectEditor.eventEffectiveRestrictionsChanged instead.

workflowRestrictions: ReadonlySet<UserRestriction>

Set of user resctrictions for the current workflow. Should not be used directly by most plugins. Use ProjectEditor.effectiveRestrictions instead.

Methods

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

    Returns Promise<void>

  • Returns true if the user is not allowed to manually change the project state. This function has priority over the current user restrictions, and thus can be user to override them.

    Returns Promise<boolean>

  • Notifies this workflow, that the project was offered. E.g. can be used to adjust the project state.

    Returns Promise<void>

  • Notifies this workflow, that the project was ordered. E.g. can be used to adjust the project state.

    Returns Promise<void>

Generated using TypeDoc