Interface TransferableUsersPage

A single page of Transferable Users returned by Interaction.getTransferableUsers.

Use hasNextPage to check whether more results exist, and pass currentPage + 1 in the next call to paginate.

interface TransferableUsersPage {
    users: TransferableUser[];
    currentPage: number;
    totalPages: number;
    totalUsers: number;
    pageSize: number;
    hasNextPage: boolean;
    hasPreviousPage: boolean;
}

Properties

The agents on this page.

currentPage: number

The current page number, 1-based.

totalPages: number

The total number of pages available.

totalUsers: number

The total number of agents across all pages.

pageSize: number

The number of agents per page.

hasNextPage: boolean

true when a subsequent page is available.

hasPreviousPage: boolean

true when a preceding page is available.