Class BannedUserListQuery

Description

A class representing query to retrieve lists related to banned User.

Hierarchy

  • default
    • BannedUserListQuery

Properties

channelType channelUrl limit

Accessors

hasNext isLoading

Methods

next

Properties

Readonly channelType

channelType: ChannelType

Description

A channel type.

Readonly channelUrl

channelUrl: string

Description

A channel URL.

Readonly limit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

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<RestrictedUser[]>

    Description

    Gets the list of RestrictedUsers. If this method is repeatedly called after each next is finished, it retrieves the following pages of the RestrictedUser 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