SendbirdChat/com.sendbird.android.params/OpenChannelListQueryParams

OpenChannelListQueryParams

data class OpenChannelListQueryParams @JvmOverloads constructor(var nameKeyword: String? = null, var urlKeyword: String? = null, var customTypeFilter: String? = null, var includeFrozen: Boolean = true, var includeMetadata: Boolean = true, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a OpenChannelListQuery object.

Since

4.0.0

See also

Constructors

Link copied to clipboard
@JvmOverloads
constructor(nameKeyword: String? = null, urlKeyword: String? = null, customTypeFilter: String? = null, includeFrozen: Boolean = true, includeMetadata: Boolean = true, limit: Int = QUERY_DEFAULT_LIMIT)

Properties

Link copied to clipboard
var customTypeFilter: String?

A filter to return only channels with the specified customType.

Link copied to clipboard
var includeFrozen: Boolean

Indicate whether to include frozen channels or not. This flag is true by default.

Link copied to clipboard
var includeMetadata: Boolean

Indicate 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
var nameKeyword: String?

Search keyword for channel name. If this is set, OpenChannelListQuery.next will return the list of OpenChannels of which name matches the specified name.

Link copied to clipboard
var urlKeyword: String?

Search keyword for channel URL. If this is set, OpenChannelListQuery.next will return the list of OpenChannels of which URL matches the specified URL.