Messages
Properties
A Message represents an individual message that is sent to or received from Ably.
name
The event name, if provided. Type: String
data
The message payload, if provided.Type: String, StringBuffer, JSON Object
extras
Metadata and/or ancillary payloads, if provided. Valid payloads include push, headers(a map of strings to strings for arbitrary customer-supplied metadata), ephemeral, and privileged objects.Type: JSON Object
id
A Unique ID assigned by Ably to this message.Type: String
clientId
The client ID of the publisher of this message.Type: String
connectionId
The connection ID of the publisher of this message.Type: String
connectionKey
A connection key, which can optionally be included for a REST publish as part of the publishing on behalf of a realtime client functionalityType: String
timestamp
Timestamp when the message was received by the Ably, as milliseconds since the epoch.Type: Integer
encoding
This will typically be 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 will contain the remaining transformations not applied to the data payload.Type: String
action
The action type of the message, one of the MessageAction enum values.Type: int enum { MESSAGE_CREATE, MESSAGE_UPDATE, MESSAGE_DELETE, META, MESSAGE_SUMMARY }
serial
This message’s unique serial (an identifier that will be the same in all future updates of this message).Type: String
refSerial
If this message references another, the serial of that message.Type: String
refType
If this message references another, the type of reference that is.Type: String
createdAt
The timestamp of the very first version of a given message (will differ from timestamp only if the message has been updated or deleted).Type: Integer
version
The version of the message, lexicographically-comparable with other versions (that share the same serial). Will differ from the serial only if the message has been updated or deleted.Type: String
operation
In the case of an updated or deleted message, this will contain metadata about the update or delete operation.Type: Operation
Message constructors
Message.fromEncoded
Message.fromEncoded(Object encodedMsg, ChannelOptions channelOptions?) → Message
A static factory method to create a Message from a deserialized Message-like object encoded using Ably’s wire protocol.
Parameters
- encodedMsg
- a
Message-like deserialized object.Type:Object - channelOptions
- an optional
ChannelOptions. If you have an encrypted channel, use this to allow the library can decrypt the data.Type:Object
Returns
A Message object
Message.fromEncodedArray
Message.fromEncodedArray(Object[] encodedMsgs, ChannelOptions channelOptions?) → Message[]
A static factory method to create an array of Messages from an array of deserialized Message-like object encoded using Ably’s wire protocol.
Parameters
- encodedMsgs
- an array of
Message-like deserialized objects.Type:Array - channelOptions
- an optional
ChannelOptions. If you have an encrypted channel, use this to allow the library can decrypt the data.Type:Object
Returns
An Array of Message objects