Class MemberListQuery

Description

A class representing query to retrieve lists related to group channel member.

Hierarchy

  • default
    • MemberListQuery

Properties

channelType channelUrl limit memberStateFilter mutedMemberFilter nicknameStartsWithFilter operatorFilter order

Accessors

hasNext isLoading

Methods

next

Properties

ReadonlychannelType

channelType: ChannelType

Description

A channel type.

ReadonlychannelUrl

channelUrl: string

Description

A channel URL.

Readonlylimit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

ReadonlymemberStateFilter

memberStateFilter: MemberStateFilter = MemberStateFilter.ALL

Description

A filter to return members with the member state matching to MemberStateFilter.

ReadonlymutedMemberFilter

mutedMemberFilter: MutedMemberFilter = MutedMemberFilter.ALL

Description

Muted member filter.

ReadonlynicknameStartsWithFilter

nicknameStartsWithFilter: null | string = null

Description

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

ReadonlyoperatorFilter

operatorFilter: OperatorFilter = OperatorFilter.ALL

Description

Operator filter.

Readonlyorder

order: MemberListOrder = MemberListOrder.MEMBER_NICKNAME_ALPHABETICAL

Description

Indicates how the query result should be ordered.

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

  • next(): Promise<Member[]>

  • Returns Promise<Member[]>

    Description

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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods