jmap-kit
    Preparing search index...

    Type Alias BaseSetRequestInvocationArgs<TObj>

    The standard arguments for creating, updating, and destroying objects via a /set call

    The interface of the object specifying invocation arguments for the create object.

    type BaseSetRequestInvocationArgs<TObj extends BaseObject> = {
        accountId: Id;
        create?: Record<Id, TObj> | null;
        destroy?: Id[] | null;
        ifInState?: string | null;
        update?: Record<Id, PatchObject> | null;
    }

    Type Parameters

    Index

    Properties

    accountId create? destroy? ifInState? update?

    Properties

    accountId: Id

    The id of the account to use. The value must be an Id

    create?: Record<Id, TObj> | null

    A map of a creation id (a temporary id set by the client) to Foo objects, or null if no objects are to be created.

    destroy?: Id[] | null

    A list of ids for objects to permanently delete, or null if no objects are to be destroyed.

    ifInState?: string | null

    This is a state string as returned by the /get method (representing the state of all objects of this type in the account).

    update?: Record<Id, PatchObject> | null

    A map of an id to a Patch object to apply to the current object with that id, or null if no objects are to be updated.

    Settings

    Member Visibility

    On This Page

    Properties