Skip to content

bpmn-server / IAppDelegate

Interface: IAppDelegate#

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

Implemented by#

Table of contents#

Properties#

Methods#

Properties#

moddleOptions#

• moddleOptions: any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:143

Methods#

getServicesProvider#

▸ getServicesProvider(execution): IServiceProvider | Promise\<IServiceProvider>

Get the service task handlers, default to this, so you can add handlers on this class directly.

Parameters#

Name Type
execution IExecution

Returns#

IServiceProvider | Promise\<IServiceProvider>

Defined in#

packages/bpmn-server/src/interfaces/common.ts:147

sendEmail#

▸ sendEmail(to, msg, body): any

Parameters#

Name Type
to any
msg any
body any

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:148

executionStarted#

▸ executionStarted(execution): any

Parameters#

Name Type
execution IExecution

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:149

startUp#

▸ startUp(options): any

Parameters#

Name Type
options any

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:150

messageThrown#

▸ messageThrown(signalId, data, messageMatchingKey, item): any

Parameters#

Name Type
signalId string
data any
messageMatchingKey any
item IItem

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:151

signalThrown#

▸ signalThrown(signalId, data, messageMatchingKey, item): any

Parameters#

Name Type
signalId string
data any
messageMatchingKey any
item IItem

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:152

issueMessage#

▸ issueMessage(messageId, data): any

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

Parameters#

Name Type
messageId string
data any

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:160

issueSignal#

▸ issueSignal(messageId, data): any

Parameters#

Name Type
messageId string
data any

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/common.ts:161

serviceCalled#

▸ serviceCalled(input, execution, item): unknown

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

Parameters#

Name Type
input Record\<string, unknown>
execution IExecution
item IItem

Returns#

unknown

Defined in#

packages/bpmn-server/src/interfaces/common.ts:167

loadDataObject#

▸ loadDataObject(name, item): unknown

Optional. Loads a data object of the model (a BPMN data object or data store, by its name) when an element connected to it runs (a data association, either way, e.g. a start event or a service task). The value is put in the instance data under the name (data.client) and saved with the instance like any data.

Parameters#

Name Type Description
name string the data object's name
item IItem the running item: its element, token and the instance data (item.data)

Returns#

unknown

Defined in#

packages/bpmn-server/src/interfaces/common.ts:176

verifyModel#

▸ verifyModel(model): IAppModelIssue[] | Promise\<IAppModelIssue[]>

Optional. The application's own checks on a model, run by verifyModel (the model editor's check, the import checks, bpmn-server verify with a server) after its own, on a model the engine could load. Returns issues in verifyModel's form; severity defaults to 'error'. Called without a running execution.

Parameters#

Name Type Description
model Object the model's name, its XML and the loaded Definition
model.name string -
model.source string -
model.definition any -

Returns#

IAppModelIssue[] | Promise\<IAppModelIssue[]>

Defined in#

packages/bpmn-server/src/interfaces/common.ts:185

Comments