Sendbird Chat SDK for Unity
SbMemberListQuery

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

Public Member Functions

void LoadNextPage (SbMemberListHandler inCompletionHandler)
 Gets the list of group channel members. The queried result is passed to handler as List. If this method is repeatedly called after each LoadNextPage() is finished, it retrieves the following pages of the group channel members list. More...
 

Properties

string NicknameStartsWithFilter [get]
 A filter to return members whose nicknames start with the specified string. More...
 
SbGroupChannelOperatorFilter OperatorFilter [get]
 Operator filter. More...
 
SbGroupChannelMutedMemberFilter MutedMemberFilter [get]
 Muted member filter. More...
 
SbMemberStateFilter MemberStateFilter [get]
 A filter to return members with the member state matching to MemberStateFilter. More...
 
SbMemberListOrder Order [get]
 Indicates how the query result should be ordered. More...
 
int Limit [get]
 The maximum number of group channel members per queried page. More...
 
bool HasNext [get]
 Whether there is a next page. More...
 
bool IsLoading [get]
 Whether the current query is in communication progress with server. More...
 

Detailed Description

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

Since
4.0.0

Member Function Documentation

◆ LoadNextPage()

void LoadNextPage ( SbMemberListHandler  inCompletionHandler)

Gets the list of group channel members. The queried result is passed to handler as List. If this method is repeatedly called after each LoadNextPage() is finished, it retrieves the following pages of the group channel members list.

Parameters
inCompletionHandler
Since
4.0.0

Property Documentation

◆ HasNext

bool HasNext
get

Whether there is a next page.

Since
4.0.0

◆ IsLoading

bool IsLoading
get

Whether the current query is in communication progress with server.

Since
4.0.0

◆ Limit

int Limit
get

The maximum number of group channel members per queried page.

Since
4.0.0

◆ MemberStateFilter

SbMemberStateFilter MemberStateFilter
get

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

Since
4.0.0

◆ MutedMemberFilter

SbGroupChannelMutedMemberFilter MutedMemberFilter
get

Muted member filter.

Since
4.0.0

◆ NicknameStartsWithFilter

string NicknameStartsWithFilter
get

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

Since
4.0.0

◆ OperatorFilter

SbGroupChannelOperatorFilter OperatorFilter
get

Operator filter.

Since
4.0.0

◆ Order

SbMemberListOrder Order
get

Indicates how the query result should be ordered.

Since
4.0.0