bpmn-server / TimerBehaviour

Class: TimerBehaviour

Behaviour ioSpecification timer message signal

each behaviour is a class it scans def and insert itself to perform actions as required

Hierarchy

• Behaviour

↳ TimerBehaviour

Table of contents

Constructors

• constructor

Properties

• node
• definition
• duration
• repeat
• timeCycle
• timeDate

Methods

• restored
• enter
• run
• exit
• getNodeAttributes
• getItemAttributes
• init
• describe
• timeDue
• getRepeat
• start
• startTimer
• expires
• end
• resume

Constructors

constructor

• new TimerBehaviour(node, definition): TimerBehaviour

Parameters

Name	Type
node	Node
definition	any

Returns

TimerBehaviour

Inherited from

Behaviour.constructor

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:45

Properties

node

• node: Node

Inherited from

Behaviour.node

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:43

---

definition

• definition: any

Inherited from

Behaviour.definition

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:44

---

duration

• duration: any

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:57

---

repeat

• repeat: number = 1

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:58

---

timeCycle

• timeCycle: any

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:59

---

timeDate

• timeDate: any

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:60

Methods

restored

▸ restored(item): void

Parameters

Name	Type
item	any

Returns

void

Inherited from

Behaviour.restored

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:50

---

enter

▸ enter(item): void

Parameters

Name	Type
item	Item

Returns

void

Inherited from

Behaviour.enter

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:53

---

run

▸ run(item): void

Parameters

Name	Type
item	Item

Returns

void

Inherited from

Behaviour.run

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:55

---

exit

▸ exit(item): void

Parameters

Name	Type
item	Item

Returns

void

Inherited from

Behaviour.exit

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:57

---

getNodeAttributes

▸ getNodeAttributes(attributes): void

Parameters

Name	Type
attributes	any[]

Returns

void

Inherited from

Behaviour.getNodeAttributes

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:59

---

getItemAttributes

▸ getItemAttributes(item, attributes): void

Parameters

Name	Type
item	Item
attributes	any[]

Returns

void

Inherited from

Behaviour.getItemAttributes

Defined in

packages/bpmn-server/src/elements/behaviours/Behaviour.ts:60

---

init

▸ init(): void

Returns

void

Overrides

Behaviour.init

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:61

---

describe

▸ describe(): string[][]

Returns

string[][]

Overrides

Behaviour.describe

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:84

---

timeDue

▸ timeDue(item, timerModifier?): Promise\<any>

return the next time the timer is due format is time format

Parameters

Name	Type	Default value	Description
item	any	undefined	-
timerModifier	any	null	for testing purposes configuration can alter the timer

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:101

---

getRepeat

▸ getRepeat(input): any

Parameters

Name	Type
input	any

Returns

any

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:141

---

start

▸ start(item): Promise\<NODE_ACTION>

Parameters

Name	Type
item	Item

Returns

Promise\<NODE_ACTION>

Overrides

Behaviour.start

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:149

---

startTimer

▸ startTimer(item): Promise\<void>

Parameters

Name	Type
item	any

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:160

---

expires

▸ expires(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:197

---

end

▸ end(item): void

Parameters

Name	Type
item	Item

Returns

void

Overrides

Behaviour.end

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:251

---

resume

▸ resume(): void

Returns

void

Overrides

Behaviour.resume

Defined in

packages/bpmn-server/src/elements/behaviours/Timer.ts:255

Comments