@ably/chat - v1.1.1
    Preparing search index...

    Interface HistoryParams

    Parameters for querying messages in a chat room.

    interface HistoryParams {
        end?: number;
        limit?: number;
        orderBy?: OrderBy;
        start?: number;
    }
    Index

    Properties

    end? limit? orderBy? start?

    Properties

    end?: number

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

    Now
    limit?: number

    The maximum number of messages to return in the response.

    100
    orderBy?: OrderBy

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

    OrderBy.NewestFirst

    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.

    The beginning of time

    Settings

    Member Visibility

    On This Page

    Properties