Contents
bpmn-server / APIEngine
Class: APIEngine
Hierarchy
-
APIComponent
↳
APIEngine
Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new APIEngine(api
): APIEngine
Parameters
Name | Type |
---|---|
api |
any |
Returns
Inherited from
APIComponent.constructor
Defined in
Properties
api
• api: BPMNAPI
Inherited from
APIComponent.api
Defined in
Accessors
server
• get
server(): IBPMNServer
Returns
Inherited from
APIComponent.server
Defined in
Methods
getUser
▸ getUser(user
): any
Parameters
Name | Type |
---|---|
user |
any |
Returns
any
Inherited from
APIComponent.getUser
Defined in
start
▸ start(name
, data?
, user?
, options?
): Promise
<IExecution
>
start a new Instance of specified model
Parameters
Name | Type | Description |
---|---|---|
name |
any |
name of the model to start. |
data |
Object |
– |
user? |
ISecureUser |
user object {} |
options |
IEngineOptions |
– |
Returns
Promise
<IExecution
>
Implementation of
Defined in
invoke
▸ invoke(query
, data?
, user?
, options?
): Promise
<IExecution
>
continue with the execution of a particular item that is in a wait state, typically a user task
Parameters
Name | Type |
---|---|
query |
any |
data |
Object |
user? |
ISecureUser |
options |
IEngineOptions |
Returns
Promise
<IExecution
>
Implementation of
Defined in
assign
▸ assign(query
, data
, assignment
, user?
, options?
): Promise
<IExecution
>
provide assignment data to a user task
Also, updates item data
Parameters
Name | Type |
---|---|
query |
any |
data |
any |
assignment |
any |
user? |
ISecureUser |
options |
IEngineOptions |
Returns
Promise
<IExecution
>
Implementation of
Defined in
throwMessage
▸ throwMessage(messageId
, data
, messageMatchingKey
, user?
, options?
): Promise
<IExecution
>
throw a message with an id, system will identify receiving item
Parameters
Name | Type |
---|---|
messageId |
any |
data |
any |
messageMatchingKey |
any |
user? |
ISecureUser |
options |
IEngineOptions |
Returns
Promise
<IExecution
>
Implementation of
Defined in
throwSignal
▸ throwSignal(signalId
, data
, messageMatchingKey
, user?
, options?
): Promise
<any
>
throw a signal with an id, system will identify receiving item(s)
Parameters
Name | Type |
---|---|
signalId |
any |
data |
any |
messageMatchingKey |
any |
user? |
ISecureUser |
options |
IEngineOptions |
Returns
Promise
<any
>
Implementation of
Defined in
startEvent
▸ startEvent(query
, elementId
, data?
, user?
, options?
): Promise
<IExecution
>
start a second event node (in a subprocess) for a running instance
Parameters
Name | Type |
---|---|
query |
any |
elementId |
any |
data |
Object |
user? |
ISecureUser |
options |
IEngineOptions |
Returns
Promise
<IExecution
>
Implementation of
Defined in
restart
▸ restart(itemQuery
, data
, user
, options?
): Promise
<IExecution
>
restarting an already completed instance at a particular node
this function requires dataStore.enableSavePoints
to be true in configuration.ts
this add a savePoint for each item, allowing you to select that item to restore it
Parameters
Name | Type | Description |
---|---|---|
itemQuery |
any |
Query to find a single item |
data |
any |
– |
user |
ISecureUser |
– |
options |
Object |
– |
Returns
Promise
<IExecution
>