Static dataStatic uiStatic addThe function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Static addUse this to add a function as an event handler for the OnPreStageChange event so that it will be called before the business process flow stage changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Static addUse this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called when the business process flow status changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Static addUse this to add a function as an event handler for the OnStageChange event so that it will be called when the business process flow stage changes.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Static addUse this to add a function as an event handler for the OnStageSelected event so that it will be called when a business process flow stage is selected.
The function will be added to the bottom of the event handler pipeline. The execution context is automatically set to be the first parameter passed to the event handler. Use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.
Static getUse this method to asynchronously retrieve the enabled business process flows that the user can switch to for an entity.
returns callback response as Promise
Static getReturns all process instances for the entity record that the calling user has access to.
returns callback response as Promise
Static moveProgresses to the next stage.
returns callback response as Promise
Static moveMoves to the previous stage.
returns callback response as Promise
Static removeUse this to remove a function as an event handler for the OnPreProcessStatusChange event.
If an anonymous function is set using the addOnPreProcessStatusChange method it cannot be removed using this method.
Static removeUse this to remove a function as an event handler for the OnPreStageChange event.
If an anonymous function is set using the addOnPreStageChange method it cannot be removed using this method.
Static removeUse this to remove a function as an event handler for the OnProcessStatusChange event.
If an anonymous function is set using the addOnProcessStatusChange method it cannot be removed using this method.
Static removeUse this to remove a function as an event handler for the OnStageChange event.
If an anonymous function is set using the addOnStageChange method it cannot be removed using this method.
Static removeUse this to remove a function as an event handler for the OnStageChange event.
If an anonymous function is set using the addOnStageChange method it cannot be removed using this method.
Static setSet a Process as the active process.
The Id of the process to make the active process.
returns callback response as Promise
Static setSets a process instance as the active instance
The Id of the process instance to make the active instance.
returns callback response as Promise
Static setSet a stage as the active stage.
the Id of the stage to make the active stage.
returns callback response as Promise
Static setUse this method to set the current status of the process instance
The new status for the process
returns callback response as Promise
Generated using TypeDoc
Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called before the business process flow status changes.