Interface QueryEventsParams

Return list of events for a specified query criteria.

interface QueryEventsParams {
    cursor?: null | EventId;
    limit?: null | number;
    order?: null | "ascending" | "descending";
    query: SuiEventFilter;
}

Properties

cursor? limit? order? query

Properties

Optional cursor

cursor?: null | EventId

optional paging cursor

Optional limit

limit?: null | number

maximum number of items per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.

Optional order

order?: null | "ascending" | "descending"

query result ordering, default to false (ascending order), oldest record first.

query

query: SuiEventFilter

The event query criteria. See Event filter documentation for examples.

Settings

Member Visibility

Theme

On This Page

cursorlimitorderquery