ChatPanelConfiguration

data class ChatPanelConfiguration @JvmOverloads constructor(    val panelTitle: String? = null,     val panelSubtitle: String? = null,     val strings: ChatPanelStrings? = null,     val collapsedStateOptions: CollapsedStateOptions? = CollapsedStateOptions.Bar(),     val expandedStateOptions: ExpandedStateOptions? = ExpandedStateOptions( panelTitle = panelTitle, panelSubtitle = panelSubtitle ),     val shareLinkUrl: String? = null,     val previewBeforeJoin: Boolean = true,     val showActiveUsers: Boolean = true,     val canSendMessage: Boolean = true,     val maxCharactersLimit: Int = BACKEND_MAX_CHARACTERS_LIMIT,     val enableAutoScroll: Boolean = true,     val autoScrollOffset: Int = 1)

A class that encloses all configurable options for an Aircore Chat Panel.

Constructors

Link copied to clipboard
fun ChatPanelConfiguration(    panelTitle: String? = null,     panelSubtitle: String? = null,     strings: ChatPanelStrings? = null,     collapsedStateOptions: CollapsedStateOptions? = CollapsedStateOptions.Bar(),     expandedStateOptions: ExpandedStateOptions? = ExpandedStateOptions( panelTitle = panelTitle, panelSubtitle = panelSubtitle ),     shareLinkUrl: String? = null,     previewBeforeJoin: Boolean = true,     showActiveUsers: Boolean = true,     canSendMessage: Boolean = true,     maxCharactersLimit: Int = BACKEND_MAX_CHARACTERS_LIMIT,     enableAutoScroll: Boolean = true,     autoScrollOffset: Int = 1)

Properties

Link copied to clipboard
val autoScrollOffset: Int = 1

Number of message hidden from the latest one before disabling auto-scroll when looking into older message.

Link copied to clipboard
val canSendMessage: Boolean = true

If true, the user will be able to send messages, otherwise the composer will be hidden.

Link copied to clipboard
val collapsedStateOptions: CollapsedStateOptions?

Options to be used for the panel's collapsed state

Link copied to clipboard
val enableAutoScroll: Boolean = true

If true, the chat will automatically scroll to the bottom when new messages arrive.

Link copied to clipboard
val expandedStateOptions: ExpandedStateOptions?

Options to be used for the panel's expanded state

Link copied to clipboard
val maxCharactersLimit: Int

Length limit per chat message. Maximum value is 2000 characters.

Link copied to clipboard
val panelSubtitle: String? = null

Subtitle to be displayed on the panel's sub-header

Link copied to clipboard
val panelTitle: String? = null

Title to be displayed on the panel's header

Link copied to clipboard
val previewBeforeJoin: Boolean = true

If true, the user will see the chat but will need to explicitly join o participate.

Link copied to clipboard
val shareLinkUrl: String? = null

String URL to be shared when the share button is clicked.

Link copied to clipboard
val showActiveUsers: Boolean = true

If true, the user will see the list and count of active users in the chat.

Link copied to clipboard
val strings: ChatPanelStrings? = null

Set of strings to be used in the panel