SendBird.GroupChannelMemberListQuery Class Reference

Public Types
enum	OperatorFilter { ALL, OPERATOR, NONOPERATOR }
enum	MutedMemberFilter { ALL, MUTED, UNMUTED }
enum	MemberStateFilter {   ALL, INVITED, INVITED_BY_FRIEND, INVITED_BY_NON_FRIEND,   JOINED }

Public Member Functions
void	SetOperatorFilter (OperatorFilter operatorFilter)
void	SetMutedMemberFilter (MutedMemberFilter mutedMemberFilter)
void	SetMemberStateFilter (MemberStateFilter memberStateFilter)
void	SetNicknameStartsWithFilter (String nickname)
void	SetLimit (int limit)
bool	HasNext ()
bool	IsLoading ()
void	Next (GroupChannelMemberListQueryResultHandler handler)
delegate void	GroupChannelMemberListQueryResultHandler (List< Member > queryResult, SendBirdException e)

Member Enumeration Documentation

MemberStateFilter

enum SendBird.GroupChannelMemberListQuery.MemberStateFilter

strong

The member state filter. Refer to setMemberStateFilter(MemberStateFilter).

Since

3.0.15

MutedMemberFilter

enum SendBird.GroupChannelMemberListQuery.MutedMemberFilter

strong

The muted member filter. Refer to setMutedMemberFilter(MutedMemberFilter).

Since

3.0.15

OperatorFilter

enum SendBird.GroupChannelMemberListQuery.OperatorFilter

strong

The operator filter. Refer to setOperatorFilter(OperatorFilter).

Since

3.0.15

Member Function Documentation

GroupChannelMemberListQueryResultHandler()

delegate void SendBird.GroupChannelMemberListQuery.GroupChannelMemberListQueryResultHandler	(	List< Member >	queryResult,
		SendBirdException	e
	)

GroupChannelMemberListQueryResult handler. This handler callback for next(GroupChannelMemberListQueryResultHandler).

Since

3.0.15

HasNext()

bool SendBird.GroupChannelMemberListQuery.HasNext ( )

inline

Checks if there is a next page.

Returns

true if there is a next page.

Since

3.0.15

IsLoading()

bool SendBird.GroupChannelMemberListQuery.IsLoading ( )

inline

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

Returns

true if the current query is not finished.

Since

3.0.15

Next()

void SendBird.GroupChannelMemberListQuery.Next ( GroupChannelMemberListQueryResultHandler  handler )

inline

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

SetLimit()

void SendBird.GroupChannelMemberListQuery.SetLimit ( int  limit )

inline

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

SetMemberStateFilter()

void SendBird.GroupChannelMemberListQuery.SetMemberStateFilter ( MemberStateFilter  memberStateFilter )

inline

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

Parameters

memberStateFilter

The member state of the members to return.

Since

3.0.15

SetMutedMemberFilter()

void SendBird.GroupChannelMemberListQuery.SetMutedMemberFilter ( MutedMemberFilter  mutedMemberFilter )

inline

Sets muted member filter.

Parameters

mutedMemberFilter

MutedMemberFilter

Since

3.0.15

SetNicknameStartsWithFilter()

void SendBird.GroupChannelMemberListQuery.SetNicknameStartsWithFilter ( String  nickname )

inline

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

Parameters

nickname

The nickname

Since

3.0.15

SetOperatorFilter()

void SendBird.GroupChannelMemberListQuery.SetOperatorFilter ( OperatorFilter  operatorFilter )

inline

Sets operator filter.

Parameters

operatorFilter

OperatorFilter

Since

3.0.15

---

The documentation for this class was generated from the following file:

• SendBird/src/GroupChannelMemberListQuery.cs