Package 

Class PresenceMessage

  • All Implemented Interfaces:
    java.lang.Cloneable 
    
public class PresenceMessage
extends BaseMessage implements Cloneable

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

    • Method Summary

      Modifier and Type Method Description
      String toString() Generate a String summary of this PresenceMessage
      Object clone()
      static PresenceMessage fromEncoded(JsonObject messageJsonObject, ChannelOptions channelOptions) Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
      static PresenceMessage fromEncoded(String messageJson, ChannelOptions channelOptions) Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
      static Array<PresenceMessage> fromEncodedArray(JsonArray presenceMsgArray, ChannelOptions channelOptions) Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
      static Array<PresenceMessage> fromEncodedArray(String presenceMsgArray, ChannelOptions channelOptions) Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
      String memberKey() Combines clientId and connectionId to ensure that multiple connected clients with an identical clientId are uniquely identifiable.A string function that returns the combined clientId and connectionId.

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

        decode, decode, encode, getDetails, toJsonObject

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PresenceMessage

        PresenceMessage()
        Default constructor

    • Method Detail

      • toString

         String toString()

        Generate a String summary of this PresenceMessage

      • fromEncoded

         static PresenceMessage fromEncoded(JsonObject messageJsonObject, ChannelOptions channelOptions)

        Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.

        Spec: TP4

        Parameters:
        messageJsonObject - The deserialized PresenceMessage-like object to decode and decrypt.
        channelOptions - A ChannelOptions object containing the cipher.

      • fromEncoded

         static PresenceMessage fromEncoded(String messageJson, ChannelOptions channelOptions)

        Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.

        Spec: TP4

        Parameters:
        messageJson - The deserialized PresenceMessage-like object to decode and decrypt.
        channelOptions - A ChannelOptions object containing the cipher.

      • fromEncodedArray

         static Array<PresenceMessage> fromEncodedArray(JsonArray presenceMsgArray, ChannelOptions channelOptions)

        Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.

        Spec: TP4

        Parameters:
        presenceMsgArray - An array of deserialized PresenceMessage-like objects to decode and decrypt.
        channelOptions - A ChannelOptions object containing the cipher.

      • fromEncodedArray

         static Array<PresenceMessage> fromEncodedArray(String presenceMsgArray, ChannelOptions channelOptions)

        Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.

        Spec: TP4

        Parameters:
        presenceMsgArray - An array of deserialized PresenceMessage-like objects to decode and decrypt.
        channelOptions - A ChannelOptions object containing the cipher.

      • memberKey

         String memberKey()

        Combines clientId and connectionId to ensure that multiple connected clients with an identical clientId are uniquely identifiable.A string function that returns the combined clientId and connectionId.

        Spec: TP3h