Skip to main content

Class: WorkflowEngine

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:133

Implements​

Constructors​

Constructor​

new WorkflowEngine(): WorkflowEngine

Returns​

WorkflowEngine

Methods​

applyTaskUpdates()​

applyTaskUpdates(workflowId, updates): Promise<WorkflowInstance | null>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:285

Parameters​

workflowId​

string

updates​

WorkflowTaskUpdate[]

Returns​

Promise<WorkflowInstance | null>

Implementation of​

IWorkflowEngine.applyTaskUpdates

getWorkflow()​

getWorkflow(workflowId): Promise<WorkflowInstance | null>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:248

Parameters​

workflowId​

string

Returns​

Promise<WorkflowInstance | null>

Implementation of​

IWorkflowEngine.getWorkflow

getWorkflowProgress()​

getWorkflowProgress(workflowId, sinceTimestamp?): Promise<WorkflowProgressUpdate | null>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:382

Parameters​

workflowId​

string

sinceTimestamp?​

string

Returns​

Promise<WorkflowProgressUpdate | null>

Implementation of​

IWorkflowEngine.getWorkflowProgress

initialize()​

initialize(config, deps): Promise<void>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:145

Parameters​

config​

WorkflowEngineConfig

deps​

WorkflowEngineDependencies

Returns​

Promise<void>

Implementation of​

IWorkflowEngine.initialize

listWorkflowDefinitions()​

listWorkflowDefinitions(): WorkflowDefinition[]

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:177

Returns​

WorkflowDefinition[]

Implementation of​

IWorkflowEngine.listWorkflowDefinitions

listWorkflows()​

listWorkflows(options?): Promise<WorkflowInstance[]>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:376

Parameters​

options?​

WorkflowQueryOptions

Returns​

Promise<WorkflowInstance[]>

Implementation of​

IWorkflowEngine.listWorkflows

offEvent()​

offEvent(listener): void

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:394

Parameters​

listener​

WorkflowEngineEventListener

Returns​

void

Implementation of​

IWorkflowEngine.offEvent

onEvent()​

onEvent(listener): void

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:390

Parameters​

listener​

WorkflowEngineEventListener

Returns​

void

Implementation of​

IWorkflowEngine.onEvent

recordEvents()​

recordEvents(events): Promise<void>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:366

Parameters​

events​

WorkflowEvent[]

Returns​

Promise<void>

Implementation of​

IWorkflowEngine.recordEvents

registerWorkflowDescriptor()​

registerWorkflowDescriptor(descriptor): Promise<void>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:163

Parameters​

descriptor​

WorkflowDescriptorPayload

Returns​

Promise<void>

Implementation of​

IWorkflowEngine.registerWorkflowDescriptor

startWorkflow()​

startWorkflow(options): Promise<WorkflowInstance>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:182

Parameters​

options​

StartWorkflowOptions

Returns​

Promise<WorkflowInstance>

Implementation of​

IWorkflowEngine.startWorkflow

unregisterWorkflowDescriptor()​

unregisterWorkflowDescriptor(workflowDefinitionId): Promise<void>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:171

Parameters​

workflowDefinitionId​

string

Returns​

Promise<void>

Implementation of​

IWorkflowEngine.unregisterWorkflowDescriptor

updateWorkflowAgencyState()​

updateWorkflowAgencyState(workflowId, agencyState): Promise<WorkflowInstance | null>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:347

Parameters​

workflowId​

string

agencyState​

{ agencyId: string; metadata?: Record<string, unknown>; seats: Record<string, WorkflowAgencySeatSnapshot>; } | undefined

Returns​

Promise<WorkflowInstance | null>

Implementation of​

IWorkflowEngine.updateWorkflowAgencyState

updateWorkflowStatus()​

updateWorkflowStatus(workflowId, status): Promise<WorkflowInstance | null>

Defined in: packages/agentos/src/core/workflows/WorkflowEngine.ts:254

Parameters​

workflowId​

string

status​

WorkflowStatus

Returns​

Promise<WorkflowInstance | null>

Implementation of​

IWorkflowEngine.updateWorkflowStatus