A class representing query to retrieve lists related to User.

Hierarchy

  • default
    • ApplicationUserListQuery

Properties

limit: number = DEFAULT_LIST_QUERY_LIMIT

The maximum number of data per queried page.

metaDataKeyFilter: null | string = null

User meta data key filter. User list containing only and exactly the passed User meta data will be returned.

metaDataValuesFilter: null | string[] = null

User meta data values filter. User list containing only and exactly the passed User meta data will be returned.

nicknameStartsWithFilter: null | string = null

A filter to return users whose nicknames start with the specified string.

userIdsFilter: null | string[] = null

User IDs filter. User list containing the passed User IDs will be returned.

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 Users. 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.