Package io.ably.lib.types

Class Message

java.lang.Object

io.ably.lib.types.BaseMessage

io.ably.lib.types.Message

All Implemented Interfaces:

java.lang.Cloneable

public class Message
extends BaseMessage

A class representing an individual message to be sent or received via the Ably Realtime service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Message.Batch	A specification for a collection of messages to be sent using the batch API
static class	Message.Serializer

Field Summary

Fields

Modifier and Type	Field	Description
com.google.gson.JsonObject	extras	Extras, if available
java.lang.String	name	The event name, if available

Fields inherited from class io.ably.lib.types.BaseMessage

clientId, connectionId, data, encoding, id, timestamp

Constructor Summary

Constructors

Constructor	Description
Message()	Default constructor
Message(java.lang.String name, java.lang.Object data)	Construct a message from event name and data
Message(java.lang.String name, java.lang.Object data, com.google.gson.JsonObject extras)
Message(java.lang.String name, java.lang.Object data, java.lang.String clientId)
Message(java.lang.String name, java.lang.Object data, java.lang.String clientId, com.google.gson.JsonObject extras)	Generic constructor

Method Summary

Modifier and Type	Method	Description
static Message	fromEncoded(com.google.gson.JsonObject messageJson, ChannelOptions channelOptions)	Refer Spec TM3 An alternative constructor that take an Message-JSON object and a channelOptions (optional), and return a Message
static Message	fromEncoded(java.lang.String messageJson, ChannelOptions channelOptions)	Refer Spec TM3 An alternative constructor that takes a Stringified Message-JSON and a channelOptions (optional), and return a Message
static Message[]	fromEncodedArray(com.google.gson.JsonArray messageArray, ChannelOptions channelOptions)	Refer Spec TM3 An alternative constructor that takes a Messages JsonArray and a channelOptions (optional), and return array of Messages.
static Message[]	fromEncodedArray(java.lang.String messagesArray, ChannelOptions channelOptions)
java.lang.String	toString()	Generate a String summary of this Message

Methods inherited from class io.ably.lib.types.BaseMessage

countFields, decode, encode, getDetails

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

The event name, if available

extras

public com.google.gson.JsonObject extras

Extras, if available

Constructor Detail

Message

public Message()

Default constructor

Message

public Message(java.lang.String name,
               java.lang.Object data)

Construct a message from event name and data

Parameters:

name -

data -

Message

public Message(java.lang.String name,
               java.lang.Object data,
               java.lang.String clientId)

Message

public Message(java.lang.String name,
               java.lang.Object data,
               com.google.gson.JsonObject extras)

Message

public Message(java.lang.String name,
               java.lang.Object data,
               java.lang.String clientId,
               com.google.gson.JsonObject extras)

Generic constructor

Parameters:

name -

data -

clientId -

extras -

Method Detail

toString

public java.lang.String toString()

Generate a String summary of this Message

Overrides:

toString in class java.lang.Object

Returns:

string

fromEncoded

public static Message fromEncoded(com.google.gson.JsonObject messageJson,
                                  ChannelOptions channelOptions)
                           throws MessageDecodeException

Refer Spec TM3
An alternative constructor that take an Message-JSON object and a channelOptions (optional), and return a Message

Parameters:

messageJson -

channelOptions -

Returns:

Throws:

MessageDecodeException

fromEncoded

public static Message fromEncoded(java.lang.String messageJson,
                                  ChannelOptions channelOptions)
                           throws MessageDecodeException

Refer Spec TM3
An alternative constructor that takes a Stringified Message-JSON and a channelOptions (optional), and return a Message

Parameters:

messageJson -

channelOptions -

Returns:

Throws:

MessageDecodeException

fromEncodedArray

public static Message[] fromEncodedArray(com.google.gson.JsonArray messageArray,
                                         ChannelOptions channelOptions)
                                  throws MessageDecodeException

Refer Spec TM3
An alternative constructor that takes a Messages JsonArray and a channelOptions (optional), and return array of Messages.

Parameters:

messageArray -

channelOptions -

Returns:

Throws:

MessageDecodeException

fromEncodedArray

public static Message[] fromEncodedArray(java.lang.String messagesArray,
                                         ChannelOptions channelOptions)
                                  throws MessageDecodeException

Parameters:

messagesArray -

channelOptions -

Returns:

Throws:

MessageDecodeException