public final class GroupChannelMemberListQuery
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static interface |
GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler
GroupChannelMemberListQueryResult handler.
|
static class |
GroupChannelMemberListQuery.MemberStateFilter
The member state filter.
|
static class |
GroupChannelMemberListQuery.MutedMemberFilter
The muted member filter.
|
static class |
GroupChannelMemberListQuery.OperatorFilter
The operator filter.
|
static class |
GroupChannelMemberListQuery.Order
The enum for
setOrder(Order) . |
Modifier and Type | Method and Description |
---|---|
static GroupChannelMemberListQuery |
create(java.lang.String channelUrl)
Creates a query instance to get members.
|
boolean |
hasNext()
Checks if there is a next page.
|
boolean |
isLoading()
Checks if the current query is in communication progress with server.
|
void |
next(GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler handler)
Gets the list of group channel members.
|
void |
setLimit(int limit)
Sets the maximum number of group channel members per queried page.
|
void |
setMemberStateFilter(GroupChannelMemberListQuery.MemberStateFilter memberStateFilter)
Sets a filter to return members with the member state matching to
GroupChannelMemberListQuery.MemberStateFilter . |
void |
setMutedMemberFilter(GroupChannelMemberListQuery.MutedMemberFilter mutedMemberFilter)
Sets muted member filter.
|
void |
setNicknameStartsWithFilter(java.lang.String nickname)
Sets a filter to return members whose nicknames start with the specified string.
|
void |
setOperatorFilter(GroupChannelMemberListQuery.OperatorFilter operatorFilter)
Sets operator filter.
|
void |
setOrder(GroupChannelMemberListQuery.Order order)
Sets how the query result should be ordered.
|
public static GroupChannelMemberListQuery create(java.lang.String channelUrl)
channelUrl
- the url of channel.public void setOperatorFilter(GroupChannelMemberListQuery.OperatorFilter operatorFilter)
operatorFilter
- GroupChannelMemberListQuery.OperatorFilter
public void setMutedMemberFilter(GroupChannelMemberListQuery.MutedMemberFilter mutedMemberFilter)
mutedMemberFilter
- GroupChannelMemberListQuery.MutedMemberFilter
public void setMemberStateFilter(GroupChannelMemberListQuery.MemberStateFilter memberStateFilter)
GroupChannelMemberListQuery.MemberStateFilter
.memberStateFilter
- The member state of the members to return.public void setNicknameStartsWithFilter(java.lang.String nickname)
nickname
- The nicknamepublic void setLimit(int limit)
limit
- The maximum number of group channel members per page.public void setOrder(GroupChannelMemberListQuery.Order order)
GroupChannelMemberListQuery.Order.MEMBER_NICKNAME_ALPHABETICAL
, the result will be
ordered by the nickname in alphabetical order.GroupChannelMemberListQuery.Order.OPERATOR_THEN_MEMBER_ALPHABETICAL
, the result will contain
the operators first, and then the members. The two groups (operators and members) will be
ordered by the nickname in alphabetical order.order
- a GroupChannelMemberListQuery.Order
value.public boolean hasNext()
true
if there is a next page.public boolean isLoading()
true
if the current query is not finished.public void next(GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler handler)
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
.handler
- A callback handler to get the queried result. Copyright © 2021, Sendbird or its affiliates. All rights reserved.
Report a bug or request a feature
For further developer documentation, see Chat SDK Documentation. That documentation contains more detailed descriptions, conceptual overviews, definitions of terms, and code examples.