Interface RealtimeHistoryParams

The RealtimeHistoryParams interface describes the parameters accepted by the following methods:

Hierarchy

  • RealtimeHistoryParams

Properties

direction end limit start untilAttach

Properties

Optional direction

direction?: "forwards" | "backwards"

The order for which messages are returned in. Valid values are 'backwards' which orders messages from most recent to oldest, or 'forwards' which orders messages from oldest to most recent. The default is 'backwards'.

Default Value

'backwards'

Optional end

end?: number

The time until messages are retrieved, specified as milliseconds since the Unix epoch.

Default Value

The current time.

Optional limit

limit?: number

An upper limit on the number of messages returned. The default is 100, and the maximum is 1000.

Default Value

100

Optional start

start?: number

The time from which messages are retrieved, specified as milliseconds since the Unix epoch.

Optional untilAttach

untilAttach?: boolean

When true, ensures message history is up until the point of the channel being attached. See continuous history for more info. Requires the direction to be backwards. If the channel is not attached, or if direction is set to forwards, this option results in an error.

Settings

Member Visibility

Theme

Generated using TypeDoc