jmap-kit
    Preparing search index...

    Type Alias BaseQueryRequestInvocationArgs<TObj, F>

    The standard arguments for querying objects via a /query call

    type BaseQueryRequestInvocationArgs<
        TObj extends BaseObject,
        F extends BaseFilterCondition,
    > = {
        accountId: Id;
        anchor?: Id | null;
        anchorOffset?: Int;
        calculateTotal?: boolean;
        filter?: FilterOperator<F> | FilterCondition<F> | null;
        limit?: UnsignedInt | null;
        position?: Int;
        sort?: Comparator<TObj>[] | null;
    }

    Type Parameters

    Index

    Properties

    accountId anchor? anchorOffset? calculateTotal? filter? limit? position? sort?

    Properties

    accountId: Id

    The id of the account to use.

    anchor?: Id | null

    An object id. If supplied, the position argument is ignored. The index of this id in the results will be used in combination with the anchorOffset argument to determine the index of the first result to return.

    anchorOffset?: Int

    (default: 0) The index of the first result to return relative to the index of the anchor, if an anchor is given. This MAY be negative.

    calculateTotal?: boolean

    (default: false) Does the client wish to know the total number of results 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

    Determines the set of Foos returned in the results. If null, all objects in the account of this type are included in the results.

    limit?: UnsignedInt | null

    The maximum number of results to return. If null, no limit presumed.

    position?: Int

    (default: 0) The zero-based index of the first id in the full list of results to return.

    sort?: Comparator<TObj>[] | null

    Lists the names of properties to compare between two records, and how to compare them, to determine which comes first in the sort. If two Foo records have an identical value for the first comparator, the next comparator will be considered, and so on. If all comparators are the same (this includes the case where an empty array or null is given as the sort argument), the sort order is server dependent, but it MUST be stable between calls to /query.

    Settings

    Member Visibility

    On This Page

    Properties