Class WorkflowEngine

Implements

IWorkflowEngine

Index

Constructors

Methods

initialize registerWorkflowDescriptor unregisterWorkflowDescriptor listWorkflowDefinitions startWorkflow getWorkflow updateWorkflowStatus applyTaskUpdates updateWorkflowAgencyState recordEvents listWorkflows getWorkflowProgress onEvent offEvent

Constructors

constructor

new WorkflowEngine(): WorkflowEngine
Returns WorkflowEngine

Methods

initialize

initialize(config, deps): Promise<void>
Parameters
- config: WorkflowEngineConfig
- deps: WorkflowEngineDependencies
Returns Promise<void>
Implementation of IWorkflowEngine.initialize
- Defined in core/workflows/WorkflowEngine.ts:145

registerWorkflowDescriptor

registerWorkflowDescriptor(descriptor): Promise<void>
Parameters
- descriptor: WorkflowDescriptorPayload
Returns Promise<void>
Implementation of IWorkflowEngine.registerWorkflowDescriptor
- Defined in core/workflows/WorkflowEngine.ts:163

unregisterWorkflowDescriptor

unregisterWorkflowDescriptor(workflowDefinitionId): Promise<void>
Parameters
- workflowDefinitionId: string
Returns Promise<void>
Implementation of IWorkflowEngine.unregisterWorkflowDescriptor
- Defined in core/workflows/WorkflowEngine.ts:171

listWorkflowDefinitions

listWorkflowDefinitions(): WorkflowDefinition[]
Returns WorkflowDefinition[]
Implementation of IWorkflowEngine.listWorkflowDefinitions
- Defined in core/workflows/WorkflowEngine.ts:177

startWorkflow

startWorkflow(options): Promise<WorkflowInstance>
Parameters
- options: StartWorkflowOptions
Returns Promise<WorkflowInstance>
Implementation of IWorkflowEngine.startWorkflow
- Defined in core/workflows/WorkflowEngine.ts:182

getWorkflow

getWorkflow(workflowId): Promise<null | WorkflowInstance>
Parameters
- workflowId: string
Returns Promise<null | WorkflowInstance>
Implementation of IWorkflowEngine.getWorkflow
- Defined in core/workflows/WorkflowEngine.ts:248

updateWorkflowStatus

updateWorkflowStatus(workflowId, status): Promise<null | WorkflowInstance>
Parameters
- workflowId: string
- status: WorkflowStatus
Returns Promise<null | WorkflowInstance>
Implementation of IWorkflowEngine.updateWorkflowStatus
- Defined in core/workflows/WorkflowEngine.ts:254

applyTaskUpdates

applyTaskUpdates(workflowId, updates): Promise<null | WorkflowInstance>
Parameters
- workflowId: string
- updates: WorkflowTaskUpdate[]
Returns Promise<null | WorkflowInstance>
Implementation of IWorkflowEngine.applyTaskUpdates
- Defined in core/workflows/WorkflowEngine.ts:285

updateWorkflowAgencyState

updateWorkflowAgencyState(workflowId, agencyState): Promise<null | WorkflowInstance>
Parameters
- workflowId: string
- agencyState: undefined | {
      agencyId: string;
      seats: Record<string, WorkflowAgencySeatSnapshot>;
      metadata?: Record<string, unknown>;
  }
Returns Promise<null | WorkflowInstance>
Implementation of IWorkflowEngine.updateWorkflowAgencyState
- Defined in core/workflows/WorkflowEngine.ts:347

recordEvents

recordEvents(events): Promise<void>
Parameters
- events: WorkflowEvent[]
Returns Promise<void>
Implementation of IWorkflowEngine.recordEvents
- Defined in core/workflows/WorkflowEngine.ts:366

listWorkflows

listWorkflows(options?): Promise<WorkflowInstance[]>
Parameters
- Optional options: WorkflowQueryOptions
Returns Promise<WorkflowInstance[]>
Implementation of IWorkflowEngine.listWorkflows
- Defined in core/workflows/WorkflowEngine.ts:376

getWorkflowProgress

getWorkflowProgress(workflowId, sinceTimestamp?): Promise<null | WorkflowProgressUpdate>
Parameters
- workflowId: string
- Optional sinceTimestamp: string
Returns Promise<null | WorkflowProgressUpdate>
Implementation of IWorkflowEngine.getWorkflowProgress
- Defined in core/workflows/WorkflowEngine.ts:382

onEvent

onEvent(listener): void
Parameters
- listener: WorkflowEngineEventListener
Returns void
Implementation of IWorkflowEngine.onEvent
- Defined in core/workflows/WorkflowEngine.ts:390

offEvent

offEvent(listener): void
Parameters
- listener: WorkflowEngineEventListener
Returns void
Implementation of IWorkflowEngine.offEvent
- Defined in core/workflows/WorkflowEngine.ts:394