jmap-kit
    Preparing search index...

    Type Alias BaseGetResponseInvocationArgs<TObj>

    type BaseGetResponseInvocationArgs<TObj extends BaseObject> = {
        accountId: Id;
        list: TObj[];
        notFound: Id[];
        state: string;
    }

    Type Parameters

    Index

    Properties

    accountId: Id

    The id of the account used for the call.

    list: TObj[]

    An array of the Foo objects requested. This is the empty array if no objects were found or if the ids argument passed in was also an empty array. The results MAY be in a different order to the ids in the request arguments. If an identical id is included more than once in the request, the server MUST only include it once in either the list or the notFound argument of the response.

    notFound: Id[]

    This array contains the ids passed to the method for records that do not exist. The array is empty if all requested ids were found or if the ids argument passed in was either null or an empty array.

    state: string

    A (preferably short) string representing the state on the server for all the data of this type in the account (not just the objects returned in this call). If the data changes, this string MUST change. If the Foo data is unchanged, servers SHOULD return the same state string on subsequent requests for this data type.

    When a client receives a response with a different state string to a previous call, it MUST either throw away all currently cached objects for the type or call Foo/changes to get the exact changes.