Package io.ably.lib.types

Class PresenceMessage

java.lang.Object

io.ably.lib.types.BaseMessage

io.ably.lib.types.PresenceMessage

All Implemented Interfaces:

java.lang.Cloneable

public class PresenceMessage
extends BaseMessage
implements java.lang.Cloneable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PresenceMessage.Action	Presence Action: the event signified by a PresenceMessage
static class	PresenceMessage.ActionSerializer
static class	PresenceMessage.Serializer

Field Summary

Fields

Modifier and Type	Field	Description
PresenceMessage.Action	action

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

clientId, connectionId, data, encoding, id, timestamp

Constructor Summary

Constructors

Constructor	Description
PresenceMessage()	Default constructor
PresenceMessage(PresenceMessage.Action action, java.lang.String clientId)	Construct a PresenceMessage from an Action and clientId
PresenceMessage(PresenceMessage.Action action, java.lang.String clientId, java.lang.Object data)	Generic constructor

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
static PresenceMessage	fromEncoded(com.google.gson.JsonObject messageJsonObject, ChannelOptions channelOptions)	Refer Spec TP4 An alternative constructor that take an PresenceMessage-JSON object and a channelOptions (optional), and return a PresenceMessage
static PresenceMessage	fromEncoded(java.lang.String messageJson, ChannelOptions channelOptions)	Refer Spec TP4 An alternative constructor that takes a Stringified PresenceMessage-JSON and a channelOptions (optional), and return a PresenceMessage
static PresenceMessage[]	fromEncodedArray(com.google.gson.JsonArray presenceMsgArray, ChannelOptions channelOptions)	Refer Spec TP4 An alternative constructor that takes a PresenceMessage JsonArray and a channelOptions (optional), and return array of PresenceMessages.
static PresenceMessage[]	fromEncodedArray(java.lang.String presenceMsgArray, ChannelOptions channelOptions)	Refer Spec TP4 An alternative constructor that takes a Stringified PresenceMessages Array and a channelOptions (optional), and return array of PresenceMessages.
java.lang.String	memberKey()	Get the member key for the PresenceMessage.
java.lang.String	toString()	Generate a String summary of this PresenceMessage

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

countFields, decode, encode, getDetails

Methods inherited from class java.lang.Object

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

Field Detail

action

public PresenceMessage.Action action

Constructor Detail

PresenceMessage

public PresenceMessage()

Default constructor

PresenceMessage

public PresenceMessage(PresenceMessage.Action action,
                       java.lang.String clientId)

Construct a PresenceMessage from an Action and clientId

Parameters:

action -

clientId -

PresenceMessage

public PresenceMessage(PresenceMessage.Action action,
                       java.lang.String clientId,
                       java.lang.Object data)

Generic constructor

Parameters:

action -

clientId -

data -

Method Detail

toString

public java.lang.String toString()

Generate a String summary of this PresenceMessage

Overrides:

toString in class java.lang.Object

Returns:

string

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

fromEncoded

public static PresenceMessage fromEncoded(com.google.gson.JsonObject messageJsonObject,
                                          ChannelOptions channelOptions)
                                   throws MessageDecodeException

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

Parameters:

messageJsonObject -

channelOptions -

Returns:

Throws:

MessageDecodeException

fromEncoded

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

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

Parameters:

messageJson -

channelOptions -

Returns:

Throws:

MessageDecodeException

fromEncodedArray

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

Refer Spec TP4
An alternative constructor that takes a PresenceMessage JsonArray and a channelOptions (optional), and return array of PresenceMessages.

Parameters:

presenceMsgArray -

channelOptions -

Returns:

Throws:

MessageDecodeException

fromEncodedArray

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

Refer Spec TP4
An alternative constructor that takes a Stringified PresenceMessages Array and a channelOptions (optional), and return array of PresenceMessages.

Parameters:

presenceMsgArray -

channelOptions -

Returns:

Throws:

MessageDecodeException

memberKey

public java.lang.String memberKey()

Get the member key for the PresenceMessage.

Returns: