jmap-kit
    Preparing search index...

    Type Alias BaseGetRequestInvocationArgs<TObj>

    The standard arguments for fetching objects via a /get call

    The interface of the object whose properties are being fetched

    type BaseGetRequestInvocationArgs<TObj extends BaseObject> = {
        accountId: Id;
        ids?: Id[] | null;
        properties?: (keyof TObj)[] | null;
    }

    Type Parameters

    Index

    Properties

    accountId ids? properties?

    Properties

    accountId: Id

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

    ids?: Id[] | null

    The ids of the objects to return. If null, then all records of the data type are returned, if this is supported for that data type and the number of records does not exceed the maxObjectsInGet limit.

    The value must be Id[] | null

    properties?: (keyof TObj)[] | null

    If supplied, only the properties listed in the array are returned for each object. If null, all properties of the object are returned. The id property of the object is always returned, even if not explicitly requested. If an invalid property is requested, the call MUST be rejected with an invalidArguments error.

    Settings

    Member Visibility

    On This Page

    Properties