AgentOS
About
Features
Blog
API Docs
Guides
Get Started
@framers/agentos
WorkflowEngine
Class WorkflowEngine
Implements
IWorkflowEngine
Index
Constructors
constructor
Methods
initialize
register
Workflow
Descriptor
unregister
Workflow
Descriptor
list
Workflow
Definitions
start
Workflow
get
Workflow
update
Workflow
Status
apply
Task
Updates
update
Workflow
Agency
State
record
Events
list
Workflows
get
Workflow
Progress
on
Event
off
Event
Constructors
constructor
new
Workflow
Engine
(
)
:
WorkflowEngine
Returns
WorkflowEngine
Methods
initialize
initialize
(
config
,
deps
)
:
Promise
<
void
>
Parameters
config
:
WorkflowEngineConfig
deps
:
WorkflowEngineDependencies
Returns
Promise
<
void
>
register
Workflow
Descriptor
register
Workflow
Descriptor
(
descriptor
)
:
Promise
<
void
>
Parameters
descriptor
:
WorkflowDescriptorPayload
Returns
Promise
<
void
>
unregister
Workflow
Descriptor
unregister
Workflow
Descriptor
(
workflowDefinitionId
)
:
Promise
<
void
>
Parameters
workflowDefinitionId
:
string
Returns
Promise
<
void
>
list
Workflow
Definitions
list
Workflow
Definitions
(
)
:
WorkflowDefinition
[]
Returns
WorkflowDefinition
[]
start
Workflow
start
Workflow
(
options
)
:
Promise
<
WorkflowInstance
>
Parameters
options
:
StartWorkflowOptions
Returns
Promise
<
WorkflowInstance
>
get
Workflow
get
Workflow
(
workflowId
)
:
Promise
<
null
|
WorkflowInstance
>
Parameters
workflowId
:
string
Returns
Promise
<
null
|
WorkflowInstance
>
update
Workflow
Status
update
Workflow
Status
(
workflowId
,
status
)
:
Promise
<
null
|
WorkflowInstance
>
Parameters
workflowId
:
string
status
:
WorkflowStatus
Returns
Promise
<
null
|
WorkflowInstance
>
apply
Task
Updates
apply
Task
Updates
(
workflowId
,
updates
)
:
Promise
<
null
|
WorkflowInstance
>
Parameters
workflowId
:
string
updates
:
WorkflowTaskUpdate
[]
Returns
Promise
<
null
|
WorkflowInstance
>
update
Workflow
Agency
State
update
Workflow
Agency
State
(
workflowId
,
agencyState
)
:
Promise
<
null
|
WorkflowInstance
>
Parameters
workflowId
:
string
agencyState
:
undefined
|
{
agencyId
:
string
;
seats
:
Record
<
string
,
WorkflowAgencySeatSnapshot
>
;
metadata
?:
Record
<
string
,
unknown
>
;
}
Returns
Promise
<
null
|
WorkflowInstance
>
record
Events
record
Events
(
events
)
:
Promise
<
void
>
Parameters
events
:
WorkflowEvent
[]
Returns
Promise
<
void
>
list
Workflows
list
Workflows
(
options
?
)
:
Promise
<
WorkflowInstance
[]
>
Parameters
Optional
options
:
WorkflowQueryOptions
Returns
Promise
<
WorkflowInstance
[]
>
get
Workflow
Progress
get
Workflow
Progress
(
workflowId
,
sinceTimestamp
?
)
:
Promise
<
null
|
WorkflowProgressUpdate
>
Parameters
workflowId
:
string
Optional
sinceTimestamp
:
string
Returns
Promise
<
null
|
WorkflowProgressUpdate
>
on
Event
on
Event
(
listener
)
:
void
Parameters
listener
:
WorkflowEngineEventListener
Returns
void
off
Event
off
Event
(
listener
)
:
void
Parameters
listener
:
WorkflowEngineEventListener
Returns
void
Settings
Member Visibility
Protected
Inherited
Alpha
Beta
Theme
OS
Light
Dark
On This Page
constructor
initialize
register
Workflow
Descriptor
unregister
Workflow
Descriptor
list
Workflow
Definitions
start
Workflow
get
Workflow
update
Workflow
Status
apply
Task
Updates
update
Workflow
Agency
State
record
Events
list
Workflows
get
Workflow
Progress
on
Event
off
Event
Architecture
Changelog
Planning Engine
Human-in-the-Loop
Agent Communication
Evaluation Framework
@framers/agentos - v1.0.1
Loading...