Interface ObjectMessage

An object message that carried an operation.

Hierarchy

  • ObjectMessage

Properties

channel clientId? connectionId? extras? id operation serial? serialTimestamp? siteCode? timestamp

Properties

channel

channel: string

The name of the channel the object message was published to.

Optional clientId

clientId?: string

The client ID of the publisher of this object message (if any).

Optional connectionId

connectionId?: string

The connection ID of the publisher of this object message (if any).

Optional extras

extras?: {
    headers?: Record<string, string>;
    [key: string]: any;
}

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

Type declaration

  • [key: string]: any
  • Optional headers?: Record<string, string>

    A set of key–value pair headers included with this object message.

id

id: string

Unique ID assigned by Ably to this object message.

operation

operation: ObjectOperation

Describes an operation that was applied to an object.

Optional serial

serial?: string

An opaque string that uniquely identifies this object message.

Optional serialTimestamp

serialTimestamp?: number

A timestamp from the serial field.

Optional siteCode

siteCode?: string

An opaque string that uniquely identifies the Ably site the object message was published to.

timestamp

timestamp: number

Timestamp of when the object message was received by Ably, as milliseconds since the Unix epoch.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc