GroupChannelListQueryParams

class GroupChannelListQueryParams @JvmOverloads constructor(var order: GroupChannelListQueryOrder = GroupChannelListQueryOrder.LATEST_LAST_MESSAGE, var includeEmpty: Boolean = false, var includeFrozen: Boolean = true, var includeMetadata: Boolean = true, var superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, var publicChannelFilter: PublicChannelFilter = PublicChannelFilter.ALL, var unreadChannelFilter: UnreadChannelFilter = UnreadChannelFilter.ALL, var hiddenChannelFilter: HiddenChannelFilter = HiddenChannelFilter.UNHIDDEN, var myMemberStateFilter: MyMemberStateFilter = MyMemberStateFilter.ALL, var metaDataOrderKeyFilter: String? = null, var customTypeStartsWithFilter: String? = null, var channelUrlsFilter: List<String>? = null, var channelNameContainsFilter: String? = null, var customTypesFilter: List<String>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a GroupChannelListQuery object.

Since

4.0.0

See also

Constructors

Link copied to clipboard
constructor(order: GroupChannelListQueryOrder = GroupChannelListQueryOrder.LATEST_LAST_MESSAGE, includeEmpty: Boolean = false, includeFrozen: Boolean = true, includeMetadata: Boolean = true, superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, publicChannelFilter: PublicChannelFilter = PublicChannelFilter.ALL, unreadChannelFilter: UnreadChannelFilter = UnreadChannelFilter.ALL, hiddenChannelFilter: HiddenChannelFilter = HiddenChannelFilter.UNHIDDEN, myMemberStateFilter: MyMemberStateFilter = MyMemberStateFilter.ALL, metaDataOrderKeyFilter: String? = null, customTypeStartsWithFilter: String? = null, channelUrlsFilter: List<String>? = null, channelNameContainsFilter: String? = null, customTypesFilter: List<String>? = null, limit: Int = QUERY_DEFAULT_LIMIT)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Restricts the search scope to only retrieve group channels which have been created after the specified time in milliseconds, inclusive.

Link copied to clipboard

Restricts the search scope to only retrieve group channels which have been created before the specified time in milliseconds, inclusive.

Link copied to clipboard

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.

Link copied to clipboard

A filter to return channels that start with the specified customType. It will return null if custom type starts with filter hasn't been set before.

Link copied to clipboard

Hidden channel filter. Refer to HiddenChannelFilter.

Link copied to clipboard

Checks whether to include chat notification GroupChannel.

Link copied to clipboard

Checks whether query result includes empty channels. (channels without messages). This flag is false by default.

Link copied to clipboard

Checks whether query result includes frozen channels. This flag is true by default.

Link copied to clipboard

Checks whether to include channel metadata on fetch. This flag is true by default.

Link copied to clipboard
var limit: Int

The maximum number of items per queried page.

Link copied to clipboard

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

Link copied to clipboard

Meta data order key filter. It will return null if meta data order key filter hasn't been set before. This filter will work only if order is GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL

Link copied to clipboard

Works exclusively with metaDataValueStartsWith.

Link copied to clipboard

Works exclusively with metaDataValues.

Link copied to clipboard

A filter to return channels with the current User state matching to MyMemberStateFilter.

Link copied to clipboard

Searches for GroupChannels with members whose nicknames contain the specified value. If you pass nickname such as "abc", then the returned channel list will be containing member like "abc". This does not cooperate with other filters.

Link copied to clipboard

Searches for GroupChannels with members whose nicknames match the specified value. This does not cooperate with other filters.

Link copied to clipboard

Searches for GroupChannels with members whose nicknames starts with the specified value. If you pass nickname such as "abc", then the returned channel list will be containing member like "abc*". This does not cooperate with other filters.

Link copied to clipboard

Public channel filter. Refer to PublicChannelFilter.

Link copied to clipboard

Search fields. Refer to setSearchFilter and SearchField.

Link copied to clipboard

Query string. Refer to setSearchFilter.

Link copied to clipboard

Super channel filter. Refer to SuperChannelFilter.

Link copied to clipboard

Unread channel filter. Refer to UnreadChannelFilter.

Link copied to clipboard

User IDs exact filter.GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters.

Link copied to clipboard

User IDs include filter. It will return null if User IDs include filter hasn't been set before.

Functions

Link copied to clipboard
fun copy(order: GroupChannelListQueryOrder = this.order, includeEmpty: Boolean = this.includeEmpty, includeFrozen: Boolean = this.includeFrozen, includeMetadata: Boolean = this.includeMetadata, superChannelFilter: SuperChannelFilter = this.superChannelFilter, publicChannelFilter: PublicChannelFilter = this.publicChannelFilter, unreadChannelFilter: UnreadChannelFilter = this.unreadChannelFilter, hiddenChannelFilter: HiddenChannelFilter = this.hiddenChannelFilter, memberStateFilter: MyMemberStateFilter = this.myMemberStateFilter, metaDataOrderKeyFilter: String? = this.metaDataOrderKeyFilter, customTypeStartsWithFilter: String? = this.customTypeStartsWithFilter, channelUrlsFilter: List<String>? = this.channelUrlsFilter, channelNameContainsFilter: String? = this.channelNameContainsFilter, customTypesFilter: List<String>? = this.customTypesFilter, limit: Int = this.limit, includeChatNotification: Boolean = this.includeChatNotification, createdBefore: Long? = this.createdBefore, createdAfter: Long? = this.createdAfter): GroupChannelListQueryParams
Link copied to clipboard
fun setMetaDataValuesFilter(metaDataKey: String, metaDataValues: List<String>)

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

Link copied to clipboard
fun setMetaDataValueStartsWithFilter(metaDataKey: String, metaDataValueStartsWith: String)

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

Link copied to clipboard
fun setSearchFilter(searchFields: List<SearchField>?, query: String?)

Sets Search filter. GroupChannels will be included in the result if its data in specified SearchFields contains specified query string. Refer to SearchField. If you set multiple SearchFields, the result will be union of each result.

Link copied to clipboard
fun setUserIdsIncludeFilter(userIds: List<String>?, queryType: QueryType)

Sets User IDs filter. GroupChannel list containing the passed User IDs and other members will be returned. This does not cooperate with other filters.