API Reference

Messages

PropertiesMembersAttributesAttributes

A Message represents an individual message that is sent to or received from Ably.

nameName

The event name, if provided.
Type: String

dataData

The message payload, if provided.
Type: String, StringBuffer, JSON ObjectString, ByteArray, JSONObject, JSONArrayString, byte[], plain C# object that can be serialized to JsonString, Binary (ASCII-8BIT String), Hash, ArrayString, Bytearray, Dict, ListString, Binary String, Associative Array, ArrayNSString *, NSData *, NSDictionary *, NSArray *String, NSData, Dictionary, ArrayString, Map, List

extrasExtras

Metadata and/or ancillary payloads, if provided. The only currently valid payload for extras is the push object.
Type: JSONObject, JSONArrayplain C# object that can be converted to JsonJSON ObjectHash, ArrayDict, ListDictionary, ArrayNSDictionary *, NSArray *Associative Array, Array

idId

A Unique ID assigned by Ably to this message. Can optionally be assigned by the client as part of idempotent publishing.
Type: String

clientIdClientIdclient_idclient_id

The client ID of the publisher of this message.
Type: String

connectionIdConnectionIdconnection_idconnection_id

The connection ID of the publisher of this message.
Type: String

timestampTimestamp

Timestamp when the message was received by the Ably, as milliseconds since the epocha Time object
.Type: IntegerLong IntegerDateTimeOffsetTimeNSDate

encodingEncoding

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

Message methods

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


Need help?

If you need any help with your implementation or if you have encountered any problems, do get in touch. You can also quickly find answers from our knowledge base, and blog.