stream-chat-android-core/io.getstream.chat.android.models/Config

Config

@Immutable

data class Config( val createdAt: Date? = null, val updatedAt: Date? = null, val name: String = "", val typingEventsEnabled: Boolean = true, val readEventsEnabled: Boolean = true, val connectEventsEnabled: Boolean = true, val searchEnabled: Boolean = true, val isReactionsEnabled: Boolean = true, val isThreadEnabled: Boolean = true, val muteEnabled: Boolean = true, val uploadsEnabled: Boolean = true, val urlEnrichmentEnabled: Boolean = true, val customEventsEnabled: Boolean = false, val pushNotificationsEnabled: Boolean = true, val skipLastMsgUpdateForSystemMsgs: Boolean = false, val pollsEnabled: Boolean = false, val messageRetention: String = "infinite", val maxMessageLength: Int = 5000, val automod: String = "disabled", val automodBehavior: String = "", val blocklistBehavior: String = "", val commands: List<Command> = mutableListOf())

Model representing the configuration of a channel.

Constructors

constructor( createdAt: Date? = null, updatedAt: Date? = null, name: String = "", typingEventsEnabled: Boolean = true, readEventsEnabled: Boolean = true, connectEventsEnabled: Boolean = true, searchEnabled: Boolean = true, isReactionsEnabled: Boolean = true, isThreadEnabled: Boolean = true, muteEnabled: Boolean = true, uploadsEnabled: Boolean = true, urlEnrichmentEnabled: Boolean = true, customEventsEnabled: Boolean = false, pushNotificationsEnabled: Boolean = true, skipLastMsgUpdateForSystemMsgs: Boolean = false, pollsEnabled: Boolean = false, messageRetention: String = "infinite", maxMessageLength: Int = 5000, automod: String = "disabled", automodBehavior: String = "", blocklistBehavior: String = "", commands: List<Command> = mutableListOf())

Properties

val automod: String

Disabled, simple or AI are valid options for the Automod. AI based moderation is a premium feature.

automodBehavior

val automodBehavior: String

Represents the automod behaviour.

blocklistBehavior

val blocklistBehavior: String

Represents the blocklist behaviour.

val commands: List<Command>

The commands that are available on this channel type, e.g. /giphy.

connectEventsEnabled

val connectEventsEnabled: Boolean = true

Determines if events are fired for connecting and disconnecting to a chat. Enabled by default.

val createdAt: Date? = null

Date of channel creation.

customEventsEnabled

val customEventsEnabled: Boolean = false

Determines if custom events are enabled. Disabled by default.

isReactionsEnabled

val isReactionsEnabled: Boolean = true

If users are allowed to add reactions to messages. Enabled by default.

isThreadEnabled

val isThreadEnabled: Boolean = true

Enables message threads. Enabled by default.

maxMessageLength

val maxMessageLength: Int = 5000

The max message length. 5000 by default.

messageRetention

val messageRetention: String

A number of days or infinite. "Infinite" by default.

val muteEnabled: Boolean = true

Determines if users are able to mute other users. Enabled by default.

val name: String

The name of the channel type must be unique per application

val pollsEnabled: Boolean = false

Determines if polls are enabled. Disabled by default.

pushNotificationsEnabled

val pushNotificationsEnabled: Boolean = true

Determines if push notifications are enabled. Enabled by default.

readEventsEnabled

val readEventsEnabled: Boolean = true

Controls whether the chat shows how far you’ve read. Enabled by default.

val searchEnabled: Boolean = true

Controls if messages should be searchable (this is a premium feature). Disabled by default.

skipLastMsgUpdateForSystemMsgs

val skipLastMsgUpdateForSystemMsgs: Boolean = false

Determines if the last message update should be skipped for system messages. Disabled by default.

typingEventsEnabled

val typingEventsEnabled: Boolean = true

Controls if typing indicators are shown. Enabled by default.

val updatedAt: Date? = null

Date of last channel update.

val uploadsEnabled: Boolean = true

Allows image and file uploads within messages. Enabled by default.

urlEnrichmentEnabled

val urlEnrichmentEnabled: Boolean = true

Determines if URL enrichment enabled to show they as attachments. Enabled by default.