Sendbird Chat SDK for .NET
Public Member Functions | Properties | List of all members
SbPublicGroupChannelListQueryParams

Params for creating a PublicGroupChannelListQuery object. More...

Public Member Functions

void SetMetaDataValuesFilter (string inMetaDataKey, List< string > inMetaDataValues)
 Sets GroupChannel meta data filter. GroupChannel list containing only and exactly the passed GroupChannel meta data will be returned. If this is set, it will reset the filter set from MetaDataValueStartsWithFilter. More...
 
void SetMetaDataValueStartsWithFilter (string inMetaDataKey, string inMetaDataValueStartsWith)
 Sets GroupChannel meta data filter. GroupChannel list containing passed GroupChannel meta data key with values that starts with the passed on value will be returned. If this is set, it will reset the filter set from MetaDataValuesFilter. More...
 

Properties

SbPublicGroupChannelListOrder Order [get, set]
 Result order of channels. Refer to SbPublicGroupChannelListOrder. More...
 
SbGroupChannelSuperChannelFilter SuperChannelFilter [get, set]
 Super channel filter. Refer to SbGroupChannelSuperChannelFilter. More...
 
bool IncludeEmptyChannel [get, set]
 Checks whether query result includes empty channels. (channels without messages). More...
 
bool IncludeFrozenChannel [get, set]
 Checks whether query result includes frozen channels. More...
 
int Limit [get, set]
 The maximum number of GroupChannels per page. More...
 
SbPublicGroupChannelMembershipFilter PublicMembershipFilter [get, set]
 Membership filter. More...
 
string ChannelNameContainsFilter [get, set]
 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...
 
List< string > ChannelUrlsFilter [get, set]
 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...
 
List< string > CustomTypesFilter [get, set]
 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, set]
 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, set]
 Whether to include channel metadata on fetch. More...
 
List< string > MetaDataValuesFilter [get]
 Works exclusively with MetaDataValueStartsWithFilter. More...
 
string MetaDataKeyFilter [get]
 The metadataKey set with either MetaDataValuesFilter or MetaDataValueStartsWithFilter. More...
 
string MetaDataOrderKeyFilter [get, set]
 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...
 

Detailed Description

Params for creating a PublicGroupChannelListQuery object.

Since
4.0.0

Member Function Documentation

◆ SetMetaDataValuesFilter()

void SetMetaDataValuesFilter ( string  inMetaDataKey,
List< string >  inMetaDataValues 
)

Sets GroupChannel meta data filter. GroupChannel list containing only and exactly the passed GroupChannel meta data will be returned. If this is set, it will reset the filter set from MetaDataValueStartsWithFilter.

Parameters
inMetaDataKey
inMetaDataValues
Since
4.0.0

◆ SetMetaDataValueStartsWithFilter()

void SetMetaDataValueStartsWithFilter ( string  inMetaDataKey,
string  inMetaDataValueStartsWith 
)

Sets GroupChannel meta data filter. GroupChannel list containing passed GroupChannel meta data key with values that starts with the passed on value will be returned. If this is set, it will reset the filter set from MetaDataValuesFilter.

Parameters
inMetaDataKey
inMetaDataValueStartsWith
Since
4.0.0

Property Documentation

◆ ChannelNameContainsFilter

string ChannelNameContainsFilter
getset

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.

Since
4.0.0

◆ ChannelUrlsFilter

List<string> ChannelUrlsFilter
getset

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.

Since
4.0.0

◆ CustomTypesFilter

List<string> CustomTypesFilter
getset

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.

Since
4.0.0

◆ CustomTypeStartsWithFilter

string CustomTypeStartsWithFilter
getset

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.

Since
4.0.0

◆ IncludeEmptyChannel

bool IncludeEmptyChannel
getset

Checks whether query result includes empty channels. (channels without messages).

Since
4.0.0

◆ IncludeFrozenChannel

bool IncludeFrozenChannel
getset

Checks whether query result includes frozen channels.

Since
4.0.0

◆ IncludeMetaData

bool IncludeMetaData
getset

Whether to include channel metadata on fetch.

Since
4.0.0

◆ Limit

int Limit
getset

The maximum number of GroupChannels per page.

Since
4.0.0

◆ MetaDataKeyFilter

string MetaDataKeyFilter
get

The metadataKey set with either MetaDataValuesFilter or MetaDataValueStartsWithFilter.

Since
4.0.0

◆ MetaDataOrderKeyFilter

string MetaDataOrderKeyFilter
getset

Meta data order key filter. It will return null if meta data order key filter hasn't been set before.

Since
4.0.0

◆ MetaDataValuesFilter

List<string> MetaDataValuesFilter
get

Works exclusively with MetaDataValueStartsWithFilter.

Since
4.0.0

◆ MetaDataValueStartsWithFilter

string MetaDataValueStartsWithFilter
get

Works exclusively with MetaDataValuesFilter.

Since
4.0.0

◆ Order

SbPublicGroupChannelListOrder Order
getset

Result order of channels. Refer to SbPublicGroupChannelListOrder.

Since
4.0.0

◆ PublicMembershipFilter

SbPublicGroupChannelMembershipFilter PublicMembershipFilter
getset

Membership filter.

Since
4.0.0

◆ SuperChannelFilter

SbGroupChannelSuperChannelFilter SuperChannelFilter
getset

Super channel filter. Refer to SbGroupChannelSuperChannelFilter.

Since
4.0.0