DefaultAppDelegate.md

bpmn-server / DefaultAppDelegate

Class: DefaultAppDelegate

Application Delegate Object to respond to various events and services:

1. receive all events from workflow
2. receive service calls
3. receive message and signal calls
4. execute scripts

Implements

• IAppDelegate

Table of contents

Constructors

• constructor

Properties

• server

Accessors

• moddleOptions

Methods

• getServicesProvider
• startUp
• sendEmail
• executionStarted
• executionEvent
• messageThrown
• issueMessage
• issueSignal
• signalThrown
• serviceCalled

Constructors

constructor

• new DefaultAppDelegate(server): DefaultAppDelegate

Parameters

Name	Type
server	any

Returns

DefaultAppDelegate

Defined in

engine/DefaultAppDelegate.ts:11

Properties

server

• server: any

Defined in

engine/DefaultAppDelegate.ts:8

Accessors

moddleOptions

• get moddleOptions(): Object

Returns

Object

Name	Type
name	string
uri	string
prefix	string
xml	{ tagAlias: string = "lowerCase" }
xml.tagAlias	string
types	({ name: string = "Task"; isAbstract: boolean = true; extends: string[] ; properties: { name: string = "result"; isAttr: boolean = true; type: string = "String" }[] ; superClass?: undefined } | { isAbstract?: undefined = true; extends?: undefined ; properties?: undefined ; name: string = "Output"; superClass: string[] })[]

Implementation of

IAppDelegate.moddleOptions

Defined in

engine/DefaultAppDelegate.ts:29

Methods

getServicesProvider

▸ getServicesProvider(context): Promise<DefaultAppDelegate>

Parameters

Name	Type
context	any

Returns

Promise<DefaultAppDelegate>

Implementation of

IAppDelegate.getServicesProvider

Defined in

engine/DefaultAppDelegate.ts:18

---

startUp

▸ startUp(options): void

Parameters

Name	Type
options	any

Returns

void

Implementation of

IAppDelegate.startUp

Defined in

engine/DefaultAppDelegate.ts:22

---

sendEmail

▸ sendEmail(to, msg, body): void

Parameters

Name	Type
to	any
msg	any
body	any

Returns

void

Implementation of

IAppDelegate.sendEmail

Defined in

engine/DefaultAppDelegate.ts:25

---

executionStarted

▸ executionStarted(execution): Promise<void>

Parameters

Name	Type
execution	IExecution

Returns

Promise<void>

Implementation of

IAppDelegate.executionStarted

Defined in

engine/DefaultAppDelegate.ts:32

---

executionEvent

▸ executionEvent(context, event): Promise<void>

Parameters

Name	Type
context	any
event	any

Returns

Promise<void>

Defined in

engine/DefaultAppDelegate.ts:35

---

messageThrown

▸ messageThrown(messageId, data, messageMatchingKey, item): Promise<void>

is called when a event throws a message

Parameters

Name	Type
messageId	any
data	any
messageMatchingKey	any
item	Item

Returns

Promise<void>

Implementation of

IAppDelegate.messageThrown

Defined in

engine/DefaultAppDelegate.ts:46

---

issueMessage

▸ issueMessage(messageId, data): Promise<void>

is called when an event throws a message that can not be answered by another process

Parameters

Name	Type
messageId	any
data	any

Returns

Promise<void>

Implementation of

IAppDelegate.issueMessage

Defined in

engine/DefaultAppDelegate.ts:64

---

issueSignal

▸ issueSignal(signalId, data): Promise<void>

Parameters

Name	Type
signalId	any
data	any

Returns

Promise<void>

Implementation of

IAppDelegate.issueSignal

Defined in

engine/DefaultAppDelegate.ts:67

---

signalThrown

▸ signalThrown(signalId, data, messageMatchingKey, item): Promise<void>

Parameters

Name	Type
signalId	any
data	any
messageMatchingKey	any
item	Item

Returns

Promise<void>

Implementation of

IAppDelegate.signalThrown

Defined in

engine/DefaultAppDelegate.ts:70

---

serviceCalled

▸ serviceCalled(serviceName, data, item): Promise<void>

is called only if the serviceTask has no implementation; otherwise the specified implementation will be called.

Parameters

Name	Type
serviceName	any
data	any
item	Item

Returns

Promise<void>

Implementation of

IAppDelegate.serviceCalled

Defined in

engine/DefaultAppDelegate.ts:82