Sendbird Chat SDK for Unity
|
A class representing query to retrieve GroupChannel list for the current User. More...
Public Member Functions | |
void | LoadNextPage (SbGroupChannelListHandler inCompletionHandler) |
Gets the list of GroupChannels. 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 GroupChannel list. If there is no more pages to be read, an empty list (not null). is returned to handler. More... | |
Properties | |
IReadOnlyList< string > | ChannelUrlsFilter [get] |
List of channel URL filter. It will return null if channel URL filter hasn't been set before. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned. More... | |
SbPublicGroupChannelListOrder | Order [get] |
Result order of channels. Refer to GroupChannelListQueryOrder. SbPublicGroupChannelListOrder.ChannelMetaDataValueAlphabetical works with metaDataOrderKeyFilter. More... | |
SbGroupChannelSuperChannelFilter | SuperChannelFilter [get] |
Super channel filter. Refer to SbGroupChannelSuperChannelFilter. More... | |
SbPublicGroupChannelMembershipFilter | PublicMembershipFilter [get] |
Membership filter. Default is SbPublicGroupChannelMembershipFilter.Joined. More... | |
bool | IncludeEmptyChannel [get] |
Checks whether query result includes empty channels. (channels without messages). More... | |
bool | IncludeFrozenChannel [get] |
Checks whether query result includes frozen channels. More... | |
string | ChannelNameContainsFilter [get] |
A channel name filter. GroupChannel list containing the passed channel name will be returned. If you pass name such as "abc", then the returned channel list will be containing name like "abc". It will return null if channel name filter hasn't been set before. More... | |
IReadOnlyList< string > | CustomTypesFilter [get] |
List of custom type filter. GroupChannel list containing only and exactly the passed custom types will be returned. It will return null if custom types filter hasn't been set before. More... | |
string | CustomTypeStartsWithFilter [get] |
A filter to return channels that start with the specified Custom Type. It will return null if custom type starts with filter hasn't been set before. More... | |
bool | IncludeMetaData [get] |
Whether to include channel metadata on fetch. More... | |
string | MetaDataKeyFilter [get] |
The metadataKey set with either MetaDataValuesFilter or MetaDataValueStartsWithFilter. More... | |
string | MetaDataOrderKeyFilter [get] |
Meta data order key filter. It will return null if meta data order key filter hasn't been set before. More... | |
string | MetaDataValueStartsWithFilter [get] |
Works exclusively with MetaDataValuesFilter. More... | |
IReadOnlyList< string > | MetaDataValuesFilter [get] |
Works exclusively with MetaDataValueStartsWithFilter. More... | |
int | Limit [get] |
The maximum number of GroupChannels per 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... | |
A class representing query to retrieve GroupChannel list for the current User.
void LoadNextPage | ( | SbGroupChannelListHandler | inCompletionHandler | ) |
Gets the list of GroupChannels. 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 GroupChannel list. If there is no more pages to be read, an empty list (not null). is returned to handler.
inCompletionHandler |
|
get |
A channel name filter. GroupChannel list containing the passed channel name will be returned. If you pass name such as "abc", then the returned channel list will be containing name like "abc". It will return null if channel name filter hasn't been set before.
|
get |
List of channel URL filter. It will return null if channel URL filter hasn't been set before. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.
|
get |
List of custom type filter. GroupChannel list containing only and exactly the passed custom types will be returned. It will return null if custom types filter hasn't been set before.
|
get |
A filter to return channels that start with the specified Custom Type. It will return null if custom type starts with filter hasn't been set before.
|
get |
Whether there is a next page.
|
get |
Checks whether query result includes empty channels. (channels without messages).
|
get |
Checks whether query result includes frozen channels.
|
get |
Whether to include channel metadata on fetch.
|
get |
Whether the current query is in communication progress with server.
|
get |
The maximum number of GroupChannels per page.
|
get |
The metadataKey set with either MetaDataValuesFilter or MetaDataValueStartsWithFilter.
|
get |
Meta data order key filter. It will return null if meta data order key filter hasn't been set before.
|
get |
Works exclusively with MetaDataValueStartsWithFilter.
|
get |
Works exclusively with MetaDataValuesFilter.
|
get |
Result order of channels. Refer to GroupChannelListQueryOrder. SbPublicGroupChannelListOrder.ChannelMetaDataValueAlphabetical works with metaDataOrderKeyFilter.
|
get |
Membership filter. Default is SbPublicGroupChannelMembershipFilter.Joined.
|
get |
Super channel filter. Refer to SbGroupChannelSuperChannelFilter.