jmap-kit
    Preparing search index...

    Type Alias BaseQueryChangesRequestInvocationArgs<TObj, F>

    The standard arguments for querying changes to objects via a /queryChanges call

    type BaseQueryChangesRequestInvocationArgs<
        TObj extends BaseObject,
        F extends BaseFilterCondition,
    > = {
        accountId: Id;
        calculateTotal?: boolean;
        filter?: FilterOperator<F> | FilterCondition<F> | null;
        maxChanges?: UnsignedInt | null;
        sinceQueryState: string;
        sort?: Comparator<TObj>[] | null;
        upToId?: Id | null;
    }

    Type Parameters

    Index

    Properties

    accountId calculateTotal? filter? maxChanges? sinceQueryState sort? upToId?

    Properties

    accountId: Id

    The id of the account to use.

    calculateTotal?: boolean

    (default: false) Does the client wish to know the total number of results now in the query? This may be slow and expensive for servers to calculate, particularly with complex filters, so clients should take care to only request the total when needed.

    filter?: FilterOperator<F> | FilterCondition<F> | null

    The filter argument that was used with Foo/query.

    maxChanges?: UnsignedInt | null

    The maximum number of changes to return in the response.

    sinceQueryState: string

    The current state of the query in the client. This is the string that was returned as the queryState argument in the Foo/query response with the same sort/filter. The server will return the changes made to the query since this state.

    sort?: Comparator<TObj>[] | null

    The sort argument that was used with Foo/query.

    upToId?: Id | null

    The last (highest-index) id the client currently has cached from the query results. When there are a large number of results, in a common case, the client may have only downloaded and cached a small subset from the beginning of the results. The server may be able to omit added or removed items that are after the client's last cached id, which can significantly increase efficiency.

    Settings

    Member Visibility

    On This Page

    Properties