jmap-kit
    Preparing search index...

    Type Alias BaseQueryChangesResponseInvocationArgs

    type BaseQueryChangesResponseInvocationArgs = {
        accountId: Id;
        added: AddedItem[];
        newQueryState: string;
        oldQueryState: string;
        removed: Id[];
        total: UnsignedInt;
    }
    Index

    Properties

    accountId: Id

    The id of the account used for the call.

    added: AddedItem[]

    The id and index in the query results (in the new state) for every Foo that has been added to the results since the old state AND every Foo in the current results that was included in the removed array (due to a filter or sort based upon a mutable property).

    If an upToId is supplied and exists in the new results, any ids that were added but have a higher index than upToId SHOULD be omitted.

    The array MUST be sorted in order of index, with the lowest index first.

    newQueryState: string

    This is the state the query will be in after applying the set of changes to the old state.

    oldQueryState: string

    This is the sinceQueryState argument echoed back; that is, the state from which the server is returning changes.

    removed: Id[]

    The id for every Foo that was in the query results in the old state and that is not in the results in the new state.

    If the server cannot calculate this exactly, the server MAY return the ids of extra Foos in addition that may have been in the old results but are not in the new results.

    If an upToId is supplied and existed in the old results, any ids that were removed but had a higher index than upToId in those results SHOULD be omitted. If the server cannot calculate this, the upToId MUST be ignored.

    If the filter or sort includes a mutable property, the server MUST include all Foos in the current results for which this property may have changed. The position of these may have moved in the results, so they must be reinserted by the client to ensure its query cache is correct.

    (only if requested) The total number of Foos in the results (given the filter). This argument MUST be omitted if the calculateTotal request argument is not true.