Constructor
new Message(destinationTopic)
Parameters:
| Name | Type | Description |
|---|---|---|
destinationTopic |
String | The topic to publish the event to. |
- Source:
Members
(static) MESSAGE_TYPE_ERROR :number
Numeric type identifier for the ErrorResponse message type.
Type:
- number
- Source:
(static) MESSAGE_TYPE_EVENT :number
Numeric type identifier for the Event message type.
Type:
- number
- Source:
(static) MESSAGE_TYPE_REQUEST :number
Numeric type identifier for the Request message type.
Type:
- number
- Source:
(static) MESSAGE_TYPE_RESPONSE :number
Numeric type identifier for the Response message type.
Type:
- number
- Source:
brokerIds :Array.<String>
The set of broker identifiers that the message is to be routed to. Setting this value will limit which brokers the message will be delivered to. This can be used in conjunction with Message#clientIds.
Type:
- Array.<String>
- Default Value:
- []
- Source:
clientIds :Array.<String>
The set of client identifiers that the message is to be routed to. Setting this value will limit which clients the message will be delivered to. This can be used in conjunction with Message#brokerIds.
Type:
- Array.<String>
- Default Value:
- []
- Source:
destinationTenantGuids :Array.<String>
The set of tenant identifiers that the message is to be routed to. Setting this value will limit which clients the message will be delivered to. This can be used in conjunction with Message#brokerIds and Message#clientIds.
Type:
- Array.<String>
- Default Value:
- []
- Source:
destinationTopic :String
The topic to publish the message to.
Type:
- String
- Source:
messageId :String
Unique identifier for the message (UUID).
Type:
- String
- Source:
messageType :Number
The numeric type of the message.
Type:
- Number
- Default Value:
- null
- Source:
otherFields :Object
Returns an object containing the set of additional fields associated with the message. These fields can be used to add "header" like values to the message without requiring modifications to be made to the payload.
Type:
- Object
- Default Value:
- {}
- Source:
payload :Buffer|String
The application-specific payload of the message.
Type:
- Buffer | String
- Default Value:
- ''
- Source:
sourceBrokerId :string
The identifier of the DXL broker that the message's originating client is connected to (set by the initial broker).
Type:
- string
- Default Value:
- ''
- Source:
sourceClientId :string
The identifier of the DXL client that sent the message (set by the broker that initially receives the message)
Type:
- string
- Default Value:
- ''
- Source:
sourceTenantGuid :String
The tenant identifier of the DXL client that sent the message (set by the broker that initially receives the message).
Type:
- String
- Default Value:
- ''
- Source:
version :Number
The version of the DXL message (used to determine the features that are available).
Type:
- Number
- Default Value:
- 2
- Source: