jmap-kit
    Preparing search index...

    Type Alias BaseCopyResponseInvocationArgs<TObj>

    type BaseCopyResponseInvocationArgs<TObj extends BaseObject> = {
        accountId: Id;
        created?: Record<Id, TObj> | null;
        fromAccountId: Id;
        newState: string;
        notCreated?:
            | Record<
                Id,
                SetError<
                    "create"
                    | "update",
                    never,
                    { existingId: Id; type: "alreadyExists" },
                >,
            >
            | null;
        oldState?: string | null;
    }

    Type Parameters

    Index

    Properties

    accountId created? fromAccountId newState notCreated? oldState?

    Properties

    accountId: Id

    The id of the account records were copied to.

    created?: Record<Id, TObj> | null

    A map of the creation id to an object containing any properties of the copied Foo object that are set by the server (such as the id in most object types; note, the id is likely to be different to the id of the object in the account it was copied from).

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

    fromAccountId: Id

    The id of the account records were copied from.

    newState: string

    The state string that will now be returned by Foo/get on the account records were copied to.

    notCreated?:
        | Record<
            Id,
            SetError<
                "create"
                | "update",
                never,
                { existingId: Id; type: "alreadyExists" },
            >,
        >
        | null

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

    oldState?: string | null

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

    Settings

    Member Visibility

    On This Page

    Properties