Interface PresenceMessageStatic

Static utilities related to presence messages.

Hierarchy

  • PresenceMessageStatic

Properties

fromEncoded: ((JsonObject, channelOptions?) => Promise<PresenceMessage>)

Type declaration

    • (JsonObject, channelOptions?): Promise<PresenceMessage>
    • 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.

      Parameters

      • JsonObject: any

        The deserialized PresenceMessage-like object to decode and decrypt.

      • Optional channelOptions: ChannelOptions

        A ChannelOptions object containing the cipher.

      Returns Promise<PresenceMessage>

fromEncodedArray: ((JsonArray, channelOptions?) => Promise<PresenceMessage[]>)

Type declaration

    • (JsonArray, channelOptions?): Promise<PresenceMessage[]>
    • 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.

      Parameters

      • JsonArray: any[]

        An array of deserialized PresenceMessage-like objects to decode and decrypt.

      • Optional channelOptions: ChannelOptions

        A ChannelOptions object containing the cipher.

      Returns Promise<PresenceMessage[]>

Methods

Generated using TypeDoc