Interface QueryOptions

Options for querying messages in a chat room.

interface QueryOptions {
    direction?: "forwards" | "backwards";
    end?: number;
    limit?: number;
    start?: number;
}

Properties

direction? end? limit? start?

Properties

Optionaldirection

direction?: "forwards" | "backwards"

The direction to query messages in. If forwards, the response will include messages from the start of the time window to the end. If backwards, the response will include messages from the end of the time window to the start. If not provided, the default is forwards.

Default Value

forwards

Optionalend

end?: number

The end of the time window to query from. If provided, the response will include messages with timestamps less than this value.

Default Value

Now

Optionallimit

limit?: number

The maximum number of messages to return in the response.

Default Value

100

Optionalstart

start?: number

The start of the time window to query from. If provided, the response will include messages with timestamps equal to or greater than this value.

Default Value

The beginning of time

Settings

Member Visibility

On This Page

Properties