APIEngine

bpmn-server / APIEngine

Class: APIEngine

Hierarchy

• APIComponent

  ↳ APIEngine

Implements

• IEngineAPI

Table of contents

Constructors

• constructor

Properties

• api

Accessors

• server

Methods

• assign
• invoke
• start
• startEvent
• throwMessage
• throwSignal

Constructors

constructor

• new APIEngine(api): APIEngine

Parameters

Name	Type
api	any

Returns

APIEngine

Inherited from

APIComponent.constructor

Defined in

API/API.ts:22

Properties

api

• api: BPMNAPI

Inherited from

APIComponent.api

Defined in

API/API.ts:20

Accessors

server

• get server(): IBPMNServer

Returns

IBPMNServer

Inherited from

APIComponent.server

Defined in

API/API.ts:25

Methods

assign

▸ assign(query, data, assignment, user, options?): Promise<IExecution>

Parameters

Name	Type
query	any
data	any
assignment	any
user	ISecureUser
options	Object

Returns

Promise<IExecution>

Implementation of

IEngineAPI.assign

Defined in

API/API.ts:60

---

invoke

▸ invoke(query, data?, user, options?): Promise<IExecution>

Parameters

Name	Type
query	any
data	Object
user	ISecureUser
options	Object

Returns

Promise<IExecution>

Implementation of

IEngineAPI.invoke

Defined in

API/API.ts:55

---

start

▸ start(name, data?, user, options?): Promise<IExecution>

Parameters

Name	Type
name	any
data	Object
user	ISecureUser
options	Object

Returns

Promise<IExecution>

Implementation of

IEngineAPI.start

Defined in

API/API.ts:51

---

startEvent

▸ startEvent(query, elementId, data?, user, options?): Promise<IExecution>

Parameters

Name	Type
query	any
elementId	any
data	Object
user	ISecureUser
options	Object

Returns

Promise<IExecution>

Implementation of

IEngineAPI.startEvent

Defined in

API/API.ts:70

---

throwMessage

▸ throwMessage(messageId, data, messageMatchingKey, user, options?): Promise<IExecution>

Parameters

Name	Type
messageId	any
data	any
messageMatchingKey	any
user	ISecureUser
options	Object

Returns

Promise<IExecution>

Implementation of

IEngineAPI.throwMessage

Defined in

API/API.ts:64

---

throwSignal

▸ throwSignal(signalId, data, messageMatchingKey, user, options?): Promise<any>

Parameters

Name	Type
signalId	any
data	any
messageMatchingKey	any
user	ISecureUser
options	Object

Returns

Promise<any>

Implementation of

IEngineAPI.throwSignal

Defined in

API/API.ts:67