SendbirdChat/com.sendbird.android.user.query/MemberListQuery

MemberListQuery

class MemberListQuery

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

Since

3.0.49

Types

enum Order : Enum<MemberListQuery.Order>

The enum for MemberListQuery.order.

Properties

val channelUrl: String

The url of the channel to get member list from.

var hasNext: Boolean

Whether there is a next page.

@get:Synchronized

var isLoading: Boolean

Whether the current query is in communication progress with server.

The maximum number of group channel members per queried page.

memberStateFilter

val memberStateFilter: MemberStateFilter

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

mutedMemberFilter

val mutedMemberFilter: MutedMemberFilter

Muted member filter.

nicknameStartsWithFilter

val nicknameStartsWithFilter: String?

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

val operatorFilter: OperatorFilter

Operator filter.

val order: MemberListQuery.Order

Indicates how the query result should be ordered.

Functions

fun next(handler: MembersHandler?)

Gets the list of group channel members. The queried result is passed to handler as List. 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 to handler.