Sendbird Chat/com.sendbird.android.params/PublicGroupChannelListQueryParams

PublicGroupChannelListQueryParams

class PublicGroupChannelListQueryParams @JvmOverloads constructor(var order: GroupChannelListQueryOrder = GroupChannelListQueryOrder.CHRONOLOGICAL, var includeEmpty: Boolean = true, var includeFrozen: Boolean = true, var includeMetadata: Boolean = true, var superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, var membershipFilter: MembershipFilter = MembershipFilter.JOINED, 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 PublicGroupChannelListQuery object.

Since

4.0.0

Constructors

PublicGroupChannelListQueryParams

@JvmOverloads

constructor(order: GroupChannelListQueryOrder = GroupChannelListQueryOrder.CHRONOLOGICAL, includeEmpty: Boolean = true, includeFrozen: Boolean = true, includeMetadata: Boolean = true, superChannelFilter: SuperChannelFilter = SuperChannelFilter.ALL, membershipFilter: MembershipFilter = MembershipFilter.JOINED, metaDataOrderKeyFilter: String? = null, customTypeStartsWithFilter: String? = null, channelUrlsFilter: List<String>? = null, channelNameContainsFilter: String? = null, customTypesFilter: List<String>? = null, limit: Int = QUERY_DEFAULT_LIMIT)

Properties

channelNameContainsFilter

var channelNameContainsFilter: String?

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.

channelUrlsFilter

var channelUrlsFilter: List<String>?

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.

createdAfter

var createdAfter: Long?

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

createdBefore

var createdBefore: Long?

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

customTypesFilter

var customTypesFilter: List<String>?

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.

customTypeStartsWithFilter

var customTypeStartsWithFilter: String?

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.

includeEmpty

var includeEmpty: Boolean

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

includeFrozen

var includeFrozen: Boolean

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

includeMetadata

var includeMetadata: Boolean

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

limit

var limit: Int

The maximum number of items per queried page.

membershipFilter

var membershipFilter: MembershipFilter

Membership filter. Default is MembershipFilter.JOINED.

metaDataKey

var metaDataKey: String?

The metadataKey set with either metaDataValues or metaDataValueStartsWith.

metaDataOrderKeyFilter

var metaDataOrderKeyFilter: String?

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

metaDataValues

var metaDataValues: List<String>?

Works exclusively with metaDataValueStartsWith.

metaDataValueStartsWith

var metaDataValueStartsWith: String?

Works exclusively with metaDataValues.

order

var order: GroupChannelListQueryOrder

Result order of channels. Refer to GroupChannelListQueryOrder. GroupChannelListQueryOrder.METADATA_VALUE_ALPHABETICAL works with metaDataOrderKeyFilter.

superChannelFilter

var superChannelFilter: SuperChannelFilter

Super channel filter. Refer to SuperChannelFilter.

Functions

copy

@JvmOverloads

fun copy(order: GroupChannelListQueryOrder = this.order, includeEmpty: Boolean = this.includeEmpty, includeFrozen: Boolean = this.includeFrozen, includeMetadata: Boolean = this.includeMetadata, superChannelFilter: SuperChannelFilter = this.superChannelFilter, membershipFilter: MembershipFilter = this.membershipFilter, 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, createdBefore: Long? = this.createdBefore, createdAfter: Long? = this.createdAfter): PublicGroupChannelListQueryParams

setMetaDataValuesFilter

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.

setMetaDataValueStartsWithFilter

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.

PublicGroupChannelListQueryParams

Since

See also

Constructors

Properties

Functions