jmap-kit
    Preparing search index...

    Type Alias BaseCopyRequestInvocationArgs<TObj, RequiredKeys>

    The standard arguments to copy or move objects between two different accounts via a /copy call

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

    type BaseCopyRequestInvocationArgs<
        TObj extends BaseObject,
        RequiredKeys extends keyof TObj = "id",
    > = {
        accountId: Id;
        create: Record<Id, RequireSome<TObj, "id" | RequiredKeys>>;
        destroyFromIfInState?: string | null;
        fromAccountId: Id;
        ifFromInState?: string | null;
        ifInState?: string | null;
        onSuccessDestroyOriginal?: boolean;
    }

    Type Parameters

    • TObj extends BaseObject
    • RequiredKeys extends keyof TObj = "id"

      A union of keys (keyof T) that are required for the create object. id is always required, even if not specified.

    Index

    Properties

    accountId create destroyFromIfInState? fromAccountId ifFromInState? ifInState? onSuccessDestroyOriginal?

    Properties

    accountId: Id

    The id of the account to copy records to.

    create: Record<Id, RequireSome<TObj, "id" | RequiredKeys>>

    A map of the creation id to an object.

    destroyFromIfInState?: string | null

    This argument is passed on as the ifInState argument to the implicit Foo/set call, if made at the end of this request to destroy the originals that were successfully copied.

    fromAccountId: Id

    The id of the account to copy records from.

    ifFromInState?: string | null

    This is a state string as returned by the /get method.

    ifInState?: string | null

    This is a state string as returned by the /get method.

    onSuccessDestroyOriginal?: boolean

    (default: false) If true, an attempt will be made to destroy the original records that were successfully copied.

    Settings

    Member Visibility

    On This Page

    Properties