Skip to content

messageflow

ralphhanna edited this page Dec 18, 2023 · 3 revisions

bpmn-server / MessageFlow

Class: MessageFlow

MessageFlow: can only be sent to active node in waiting

  • or to a start event

Hierarchy

  • Flow

    ↳ MessageFlow

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new MessageFlow(id, type, from, to, def): MessageFlow

Parameters

Name Type
id any
type any
from any
to any
def any

Returns

MessageFlow

Inherited from

Flow.constructor

Defined in

elements/Flow.ts:16

Properties

behaviours

• behaviours: Map<any, any>

Inherited from

Flow.behaviours

Defined in

elements/Element.ts:17


def

• def: any

Inherited from

Flow.def

Defined in

elements/Flow.ts:14


from

• from: Node

Inherited from

Flow.from

Defined in

elements/Flow.ts:12


id

• id: any

Inherited from

Flow.id

Defined in

elements/Element.ts:13


isFlow

• isFlow: boolean = false

Inherited from

Flow.isFlow

Defined in

elements/Element.ts:18


isMessageFlow

• isMessageFlow: boolean = true

Overrides

Flow.isMessageFlow

Defined in

elements/Flow.ts:78


lane

• lane: any

Inherited from

Flow.lane

Defined in

elements/Element.ts:19


name

• name: any

Inherited from

Flow.name

Defined in

elements/Element.ts:16


subType

• subType: any

Inherited from

Flow.subType

Defined in

elements/Element.ts:15


to

• to: Node

Inherited from

Flow.to

Defined in

elements/Flow.ts:13


type

• type: any

Inherited from

Flow.type

Defined in

elements/Element.ts:14

Methods

addBehaviour

▸ addBehaviour(nane, behavriour): void

Parameters

Name Type
nane any
behavriour any

Returns

void

Inherited from

Flow.addBehaviour

Defined in

elements/Element.ts:39


continue

▸ continue(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Flow.continue

Defined in

elements/Element.ts:20


describe

▸ describe(): any[][]

Returns

any[][]

Inherited from

Flow.describe

Defined in

elements/Flow.ts:26


evaluateCondition

▸ evaluateCondition(item): any

Parameters

Name Type
item any

Returns

any

Inherited from

Flow.evaluateCondition

Defined in

elements/Flow.ts:53


execute

▸ execute(item): Promise<void>

Parameters

Name Type
item Item

Returns

Promise<void>

Overrides

Flow.execute

Defined in

elements/Flow.ts:80


getBehaviour

▸ getBehaviour(name): any

Parameters

Name Type
name any

Returns

any

Inherited from

Flow.getBehaviour

Defined in

elements/Element.ts:36


hasBehaviour

▸ hasBehaviour(name): boolean

respond by providing behaviour attributes beyond item and node information ex: timer due , input/outupt , fields

Parameters

Name Type
name any

Returns

boolean

Inherited from

Flow.hasBehaviour

Defined in

elements/Element.ts:32


restored

▸ restored(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Flow.restored

Defined in

elements/Element.ts:22


resume

▸ resume(item): void

Parameters

Name Type
item Item

Returns

void

Inherited from

Flow.resume

Defined in

elements/Element.ts:25


run

▸ run(item): FLOW_ACTION

if flow has a condition, it must be evaluated and if result is true flow will continue otherwise, flow will be discarded.

Parameters

Name Type
item Item

Returns

FLOW_ACTION

Inherited from

Flow.run

Defined in

elements/Flow.ts:43

Clone this wiki locally