jmap-kit
    Preparing search index...

    Type Alias BaseSetResponseInvocationArgs<TObj>

    type BaseSetResponseInvocationArgs<TObj extends BaseObject> = {
        accountId: Id;
        created?: Record<Id, TObj> | null;
        destroyed?: Id[] | null;
        newState: string;
        notCreated?: Record<Id, SetError<"create">> | null;
        notDestroyed?: Record<Id, SetError<"destroy">> | null;
        notUpdated?: Record<Id, SetError<"update">> | null;
        oldState?: string | null;
        updated?: Record<Id, TObj | null> | null;
    }

    Type Parameters

    Index

    Properties

    accountId created? destroyed? newState notCreated? notDestroyed? notUpdated? oldState? updated?

    Properties

    accountId: Id

    The id of the account used for the call.

    created?: Record<Id, TObj> | null

    A map of the creation id to an object containing any properties of the created Foo object that were not sent by the client. This includes all server-set properties (such as the id in most object types) and any properties that were omitted by the client and thus set to a default by the server.

    This argument is null if no Foo objects were successfully created.

    destroyed?: Id[] | null

    A list of Foo ids for records that were successfully destroyed, or null if none.

    newState: string

    The state string that will now be returned by Foo/get.

    notCreated?: Record<Id, SetError<"create">> | null

    A map of the creation id to a SetError object for each record that failed to be created, or null if all successful.

    notDestroyed?: Record<Id, SetError<"destroy">> | null

    A map of the Foo id to a SetError object for each record that failed to be destroyed, or null if all successful.

    notUpdated?: Record<Id, SetError<"update">> | null

    A map of the Foo id to a SetError object for each record that failed to be updated, or null if all successful.

    oldState?: string | null

    The state string that would have been returned by Foo/get before making the requested changes, or null if the server doesn’t know what the previous state string was.

    updated?: Record<Id, TObj | null> | null

    The keys in this map are the ids of all Foos that were successfully updated.

    The value for each id is a Foo object containing any property that changed in a way not explicitly requested by the PatchObject sent to the server, or null if none. This lets the client know of any changes to server-set or computed properties.

    This argument is null if no Foo objects were successfully updated.

    Settings

    Member Visibility

    On This Page

    Properties