Skip to main content

Interface: IWorkflowEngine

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:38

Methods​

applyTaskUpdates()​

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

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:53

Parameters​

workflowId​

string

updates​

WorkflowTaskUpdate[]

Returns​

Promise<WorkflowInstance | null>

getWorkflow()​

getWorkflow(workflowId): Promise<WorkflowInstance | null>

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:49

Parameters​

workflowId​

string

Returns​

Promise<WorkflowInstance | null>

getWorkflowProgress()​

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

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:60

Parameters​

workflowId​

string

sinceTimestamp?​

string

Returns​

Promise<WorkflowProgressUpdate | null>

initialize()​

initialize(config, deps): Promise<void>

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:39

Parameters​

config​

WorkflowEngineConfig

deps​

WorkflowEngineDependencies

Returns​

Promise<void>

listWorkflowDefinitions()​

listWorkflowDefinitions(): WorkflowDefinition[]

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:45

Returns​

WorkflowDefinition[]

listWorkflows()​

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

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:58

Parameters​

options?​

WorkflowQueryOptions

Returns​

Promise<WorkflowInstance[]>

offEvent()​

offEvent(listener): void

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:64

Parameters​

listener​

WorkflowEngineEventListener

Returns​

void

onEvent()​

onEvent(listener): void

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:62

Parameters​

listener​

WorkflowEngineEventListener

Returns​

void

recordEvents()​

recordEvents(events): Promise<void>

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:55

Parameters​

events​

WorkflowEvent[]

Returns​

Promise<void>

registerWorkflowDescriptor()​

registerWorkflowDescriptor(descriptor): Promise<void>

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:41

Parameters​

descriptor​

WorkflowDescriptorPayload

Returns​

Promise<void>

startWorkflow()​

startWorkflow(options): Promise<WorkflowInstance>

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:47

Parameters​

options​

StartWorkflowOptions

Returns​

Promise<WorkflowInstance>

unregisterWorkflowDescriptor()​

unregisterWorkflowDescriptor(workflowDefinitionId): Promise<void>

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:43

Parameters​

workflowDefinitionId​

string

Returns​

Promise<void>

updateWorkflowAgencyState()​

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

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:56

Parameters​

workflowId​

string

agencyState​

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

Returns​

Promise<WorkflowInstance | null>

updateWorkflowStatus()​

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

Defined in: packages/agentos/src/core/workflows/IWorkflowEngine.ts:51

Parameters​

workflowId​

string

status​

WorkflowStatus

Returns​

Promise<WorkflowInstance | null>