Function getPage

Returns (
    qualifier:
        | Readonly<{ ids: string[] }>
        | Readonly<{ contactType: string }>,
    cursor?: Nullable<string>,
    limit?: number | `${number}`,
) => Promise<Page<Contact.v1.Contact>>

a function for retrieving a paged array of contacts

• • (
        qualifier:
            | Readonly<{ ids: string[] }>
            | Readonly<{ contactType: string }>,
        cursor?: Nullable<string>,
        limit?: number | `${number}`,
    ): Promise<Page<Contact.v1.Contact>>

  • Returns an array of contacts for the provided page specifications.

    Parameters

    • qualifier: Readonly<{ ids: string[] }> | Readonly<{ contactType: string }>

      the limiter defining which contacts to return (a contact type or a set of UUIDs)

    • cursor: Nullable<string> = null

      the token identifying which page to retrieve. A null value indicates the first page should be returned. Subsequent pages can be retrieved by providing the cursor returned with the previous page.

    • limit: number | `${number}` = DEFAULT_DOCS_PAGE_LIMIT

      the maximum number of contacts to return. Default is 100.

    Returns Promise<Page<Contact.v1.Contact>>

    a page of contacts for the provided specification

    Throws

    InvalidArgumentError if no qualifier is provided or if the qualifier is invalid

    Throws

    InvalidArgumentError if the provided limit value is <=0

    Throws

    InvalidArgumentError if the provided cursor is not a valid page token or null