A class representing query to retrieve lists related to participant.

Hierarchy

  • default
    • ParticipantListQuery

Properties

Accessors

Methods

Properties

channelType: ChannelType

A channel type.

channelUrl: string

A channel URL.

limit: number = DEFAULT_LIST_QUERY_LIMIT

The maximum number of data per queried page.

Accessors

  • get hasNext(): boolean
  • Returns boolean

    Whether there is a next page.

  • get isLoading(): boolean
  • Returns boolean

    Whether the current query is in communication progress with server.

Methods

  • Returns Promise<User[]>

    Gets the list of Participants. If this method is repeatedly called after each next is finished, it retrieves the following pages of the User list. If there is no more pages to be read, an empty List (not null) is returned.