Interface PresenceMessage

Contains an individual presence update sent to, or received from, Ably.

Hierarchy

  • PresenceMessage

Properties

action: PresenceAction

The type of PresenceAction the PresenceMessage is for.

clientId: string

The ID of the client that published the PresenceMessage.

connectionId: string

The ID of the connection associated with the client that published the PresenceMessage.

data: any

The payload of the PresenceMessage.

encoding: string

This will typically be empty as all presence 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.

extras: any

A JSON object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads. Valid payloads include headers.

id: string

A unique ID assigned to each PresenceMessage by Ably.

timestamp: number

The time the PresenceMessage was received by Ably, as milliseconds since the Unix epoch.

Generated using TypeDoc