-
public final class GroupChannelMemberListQuery
A class representing query to retrieve lists related to group channel member.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
GroupChannelMemberListQuery.OperatorFilter
The operator filter. Refer to setOperatorFilter.
public enum
GroupChannelMemberListQuery.MutedMemberFilter
The muted member filter. Refer to setMutedMemberFilter.
public enum
GroupChannelMemberListQuery.MemberStateFilter
The member state filter. Refer to setMemberStateFilter.
public enum
GroupChannelMemberListQuery.Order
The enum for setOrder.
public interface
GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler
GroupChannelMemberListQueryResult handler. This handler callback for next.
-
Method Summary
Modifier and Type Method Description static GroupChannelMemberListQuery
create(@NonNull() String channelUrl)
Creates a query instance to get members. void
setOperatorFilter(GroupChannelMemberListQuery.OperatorFilter operatorFilter)
Sets operator filter. void
setMutedMemberFilter(GroupChannelMemberListQuery.MutedMemberFilter mutedMemberFilter)
Sets muted member filter. void
setMemberStateFilter(GroupChannelMemberListQuery.MemberStateFilter memberStateFilter)
Sets a filter to return members with the member state matching to MemberStateFilter. void
setNicknameStartsWithFilter(String nickname)
Sets a filter to return members whose nicknames start with the specified string. void
setLimit(int limit)
Sets the maximum number of group channel members per queried page. void
setOrder(GroupChannelMemberListQuery.Order order)
Sets how the query result should be ordered. boolean
hasNext()
Checks if there is a next page. synchronized boolean
isLoading()
Checks if the current query is in communication progress with server. synchronized void
next(GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler handler)
Gets the list of group channel members. -
-
Method Detail
-
create
@NonNull() static GroupChannelMemberListQuery create(@NonNull() String channelUrl)
Creates a query instance to get members.
- Parameters:
channelUrl
- the url of channel.
-
setOperatorFilter
void setOperatorFilter(GroupChannelMemberListQuery.OperatorFilter operatorFilter)
Sets operator filter.
- Parameters:
operatorFilter
- OperatorFilter
-
setMutedMemberFilter
void setMutedMemberFilter(GroupChannelMemberListQuery.MutedMemberFilter mutedMemberFilter)
Sets muted member filter.
- Parameters:
mutedMemberFilter
- MutedMemberFilter
-
setMemberStateFilter
void setMemberStateFilter(GroupChannelMemberListQuery.MemberStateFilter memberStateFilter)
Sets a filter to return members with the member state matching to MemberStateFilter.
- Parameters:
memberStateFilter
- The member state of the members to return.
-
setNicknameStartsWithFilter
void setNicknameStartsWithFilter(String nickname)
Sets a filter to return members whose nicknames start with the specified string.
- Parameters:
nickname
- The nickname
-
setLimit
void setLimit(int limit)
Sets the maximum number of group channel members per queried page.
- Parameters:
limit
- The maximum number of group channel members per page.
-
setOrder
void setOrder(GroupChannelMemberListQuery.Order order)
Sets how the query result should be ordered. If set to
- MEMBER_NICKNAME_ALPHABETICAL, the result will beordered by the nickname in alphabetical order.
- OPERATOR_THEN_MEMBER_ALPHABETICAL, the result will containthe operators first, and then the members. The two groups (operators and members) will beordered by the nickname in alphabetical order.
- Parameters:
order
- a Order value.
-
hasNext
boolean hasNext()
Checks if there is a next page.
-
isLoading
synchronized boolean isLoading()
Checks if the current query is in communication progress with server.
-
next
synchronized void next(GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler handler)
Gets the list of group channel members. The queried result is passed to
handler
asList
.If this method is repeatedly called after eachnext()
is finished, it retrieves the following pages of the group channel members list.If there is no more pages to be read, an emptyList
(notnull
)is returned tohandler
.- Parameters:
handler
- A callback handler to get the queried result.
-
-
-
-