Class Message

Hierarchy

Message

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Message(code: string, sender: any, context?: any, priority?: MessagePriority): Message

- Defined in core/messagesystem/message.ts:17
Class constructor.

Parameters
- code: string
- sender: any
- Optional context: any
- priority: MessagePriority = MessagePriority.NORMAL
Returns Message

Properties

code

code: string

context

context: any

priority

priority: MessagePriority

sender

sender: any

Methods

Static send

send(code: string, sender: any, context?: any): void

- Defined in core/messagesystem/message.ts:30
Sends a message to the message bus.

Parameters
- code: string
- sender: any
- Optional context: any
Returns void
void

Static sendPriority

sendPriority(code: string, sender: any, context?: any): void

- Defined in core/messagesystem/message.ts:40
Sends a priority message to the message bus to be handled immediately.

Parameters
- code: string
- sender: any
- Optional context: any
Returns void
void

Static subscribe

subscribe(code: string, handler: IMessageHandler): void

- Defined in core/messagesystem/message.ts:49
Subscribes a message handler to all message codes sent.

Parameters
- code: string
- handler: IMessageHandler
Returns void
void

Static unsubscribe

unsubscribe(code: string, handler: IMessageHandler): void

- Defined in core/messagesystem/message.ts:58
Unsubscribes the handler from the message codes.

Parameters
- code: string
- handler: IMessageHandler
Returns void
void

Static unsubscribeHandlerFromAll

unsubscribeHandlerFromAll(handler: IMessageHandler): void

- Defined in core/messagesystem/message.ts:66
Unsubscribes the handler from all messages.

Parameters
- handler: IMessageHandler
Returns void
void

Generated using TypeDoc