Workflow Class

Workflow class. A Workflow is a defined sequence of tasks used to accomplish a goal.

Extends

Methods

Name Description
constructor(workflowDef: WorkflowProps): Workflow    
getSortedTasks(): Task[] Gets an array of sorted Tasks in the Workflow.  
getTask(taskId: string): Task | undefined Gets a Task with a given Id.  
setActiveTask(task: Task): void Sets a Task as active.  

Inherited methods

Name Inherited from Description
setLabel(v: string | StringGetter): void ItemDefBase Set the label.
setTooltip(v: string | StringGetter): void ItemDefBase Set the tooltip.
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static ItemDefBase  

Properties

Name Type Description
activeTask Accessor ReadOnly Task | undefined Gets the active Task.  
activeTaskId string | null Active Task Id  
defaultTaskId string Default Task Id  
id Accessor ReadOnly string Gets the Id of the Workflow.  
isActive Accessor boolean Determines if the Workflow is active.  
isDefault boolean Indicates whether this Workflow is the default  
lastActiveTask Accessor ReadOnly Task | undefined Gets the last active Task.  
workflowId string Id of the Workflow  

Inherited properties

Name Type Inherited from Description
applicationData undefined | any ItemDefBase  
betaBadge boolean ItemDefBase  
iconElement undefined | React.ReactNode ItemDefBase  
iconSpec string | React.ReactNode ItemDefBase  
isEnabled boolean ItemDefBase  
isPressed boolean ItemDefBase  
isVisible boolean ItemDefBase  
label Accessor ReadOnly string ItemDefBase Get the label string
stateFunc undefined | (state: Readonly<BaseItemState>) => BaseItemState ItemDefBase  
stateSyncIds string[] ItemDefBase  
tooltip Accessor ReadOnly string ItemDefBase Get the tooltip string
trayId Accessor ReadOnly undefined ItemDefBase  

Defined in

Last Updated: 20 September, 2019