com.sendbird.android

Class GroupChannelMemberListQuery

java.lang.Object

com.sendbird.android.GroupChannelMemberListQuery

public final class GroupChannelMemberListQuery
extends java.lang.Object

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

Since:

3.0.49

Nested Class Summary

Nested Classes

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).

Method Summary

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static GroupChannelMemberListQuery create(java.lang.String channelUrl)

Creates a query instance to get members.

Parameters:

channelUrl - the url of channel.

Returns:

Query to use.

Since:

3.1.5

setOperatorFilter

public void setOperatorFilter(GroupChannelMemberListQuery.OperatorFilter operatorFilter)

Sets operator filter.

Parameters:

operatorFilter - GroupChannelMemberListQuery.OperatorFilter

Since:

3.0.51

setMutedMemberFilter

public void setMutedMemberFilter(GroupChannelMemberListQuery.MutedMemberFilter mutedMemberFilter)

Sets muted member filter.

Parameters:

mutedMemberFilter - GroupChannelMemberListQuery.MutedMemberFilter

Since:

3.0.51

setMemberStateFilter

public void setMemberStateFilter(GroupChannelMemberListQuery.MemberStateFilter memberStateFilter)

Sets a filter to return members with the member state matching to GroupChannelMemberListQuery.MemberStateFilter.

Parameters:

memberStateFilter - The member state of the members to return.

Since:

3.0.62

setNicknameStartsWithFilter

public void setNicknameStartsWithFilter(java.lang.String nickname)

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

Parameters:

nickname - The nickname

Since:

3.0.63

setLimit

public 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.

Since:

3.0.49

setOrder

public void setOrder(GroupChannelMemberListQuery.Order order)

Sets how the query result should be ordered. If set to

1. GroupChannelMemberListQuery.Order.MEMBER_NICKNAME_ALPHABETICAL, the result will be ordered by the nickname in alphabetical order.
2. 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.

Parameters:

order - a GroupChannelMemberListQuery.Order value.

Since:

3.0.140

hasNext

public boolean hasNext()

Checks if there is a next page.

Returns:

true if there is a next page.

Since:

3.0.49

isLoading

public boolean isLoading()

Checks if the current query is in communication progress with server.

Returns:

true if the current query is not finished.

Since:

3.0.49

next

public void next(GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler handler)

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.

Parameters:

handler - A callback handler to get the queried result.

Since:

3.0.49