The client ID of the publisher of this message.
Optional connectionThe connection ID of the publisher of this message.
The message payload, if provided.
This is typically empty, as all messages received from Ably are automatically decoded client-side using this value. However, if the message encoding cannot be processed, this attribute contains the remaining transformations not applied to the data payload.
A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads. Valid payloads include push, delta, ref and headers.
Unique ID assigned by Ably to this message.
The event name.
Timestamp of when the message was received by Ably, as milliseconds since the Unix epoch.
Static fromA static factory method to create a Message object from a deserialized Message-like object encoded using Ably's wire protocol.
A Message object.
A Message-like deserialized object.
Optional channelOptions: ChannelOptions
A ChannelOptions object. If you have an encrypted channel, use this to allow the library to decrypt the data.
Static fromA static factory method to create an array of Message objects from an array of deserialized Message-like object encoded using Ably's wire protocol.
An array of Message objects.
An array of Message-like deserialized objects.
Optional channelOptions: ChannelOptions
A ChannelOptions object. If you have an encrypted channel, use this to allow the library to decrypt the data.
Generated using TypeDoc
Contains an individual message that is sent to, or received from, Ably.