Function getSummariesPage

Returns (
    qualifier: IdsQualifier,
    cursor?: Nullable<string>,
    limit?: number | `${number}`,
) => Promise<Page<ContactSummary>>

a function for retrieving a paged array of contact summaries

• • (
        qualifier: IdsQualifier,
        cursor?: Nullable<string>,
        limit?: number | `${number}`,
    ): Promise<Page<ContactSummary>>

  • Returns a page of summary records for the contacts identified by the given qualifier. Any identifiers that do not identify an existing contact are silently omitted from the result.

    Parameters

    • qualifier: IdsQualifier

      the identifiers of the contacts to summarise

    • 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 summaries to return. Default is 100.

    Returns Promise<Page<ContactSummary>>

    a page of contact summaries for the provided specification

    Throws

    InvalidArgumentError if the qualifier does not contain an array of non-empty identifier strings

    Throws

    InvalidArgumentError if the provided limit value is <=0

    Throws

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