Class ApplicationUserListQuery

Description

A class representing query to retrieve lists related to User.

Hierarchy

  • default
    • ApplicationUserListQuery

Properties

limit metaDataKeyFilter metaDataValuesFilter nicknameStartsWithFilter userIdsFilter

Accessors

hasNext isLoading

Methods

next

Properties

Readonly limit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

Readonly metaDataKeyFilter

metaDataKeyFilter: null | string = null

Description

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

Readonly metaDataValuesFilter

metaDataValuesFilter: null | string[] = null

Description

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

Readonly nicknameStartsWithFilter

nicknameStartsWithFilter: null | string = null

Description

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

Readonly userIdsFilter

userIdsFilter: null | string[] = null

Description

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

Accessors

hasNext

  • get hasNext(): boolean

  • Returns boolean

    Description

    Whether there is a next page.

isLoading

  • get isLoading(): boolean

  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

next

  • Returns Promise<User[]>

    Description

    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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc