Description

A class representing query to retrieve lists related to friend.

Hierarchy

  • default
    • FriendListQuery

Properties

Accessors

Methods

Properties

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

Accessors

  • get hasNext(): boolean
  • Returns boolean

    Description

    Whether there is a next page.

  • get isLoading(): boolean
  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

  • Returns Promise<User[]>

    Description

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

Generated using TypeDoc