kindlysdk/no.kindly.chatsdk.chat.models

Package-level declarations

Types

data class KindlyEvent(val type: KindlyEventType, val detail: KindlyEventDetail, val timestamp: Date = Date())

Main event structure emitted by the Kindly SDK

data class KindlyEventAttachment(val id: String, val name: String, val format: String, val status: String, val sender: String, val storagePath: String)

Attachment data for events

KindlyEventButton

data class KindlyEventButton(val id: String? = null, val type: String, val label: String, val value: String? = null, val index: Int? = null, val hasBeenSelected: Boolean = false, val context: Map<String, Any>? = null)

Button data for events

KindlyEventDetail

sealed class KindlyEventDetail

Event details that can be associated with different event types

KindlyEventExchangeType

enum KindlyEventExchangeType : Enum<KindlyEventExchangeType>

Exchange types for events

KindlyEventGlobalIcon

data class KindlyEventGlobalIcon(val type: String, val source: String = "user", val value: Map<String, Any>? = null)

Global icon action data for events

KindlyEventImage

data class KindlyEventImage(val url: String, val altText: String? = null, val id: String? = null)

Image data for events

KindlyEventLanguage

data class KindlyEventLanguage(val code: String, val name: String, val isDefault: Boolean = false)

Language data for events

KindlyEventMessage

data class KindlyEventMessage(val id: String, val text: String? = null, val sender: KindlyEventMessageSender, val created: Date? = null, val isFromUser: Boolean, val exchangeID: String? = null, val videoSource: String? = null, val exchangeType: KindlyEventExchangeType? = null, val buttons: List<KindlyEventButton> = emptyList(), val images: List<KindlyEventImage> = emptyList(), val attachments: List<KindlyEventAttachment> = emptyList())

Message data for events

KindlyEventMessageSender

enum KindlyEventMessageSender : Enum<KindlyEventMessageSender>

Message sender types for events

KindlyEventSettings

data class KindlyEventSettings(val name: String, val id: String, val languages: List<KindlyEventLanguage>, val style: KindlyEventStyle)

Settings data for load events

KindlyEventState

data class KindlyEventState(val isChatDisplayed: Boolean, val isStarted: Boolean, val isSocketConnected: Boolean, val isConnected: Boolean, val connectionState: String)

State data for events

KindlyEventStyle

data class KindlyEventStyle(val background: String? = null, val buttonBackground: String? = null, val buttonText: String? = null, val headerBackground: String? = null, val headerText: String? = null, val inputBackground: String? = null, val inputText: String? = null, val userMessageBackground: String? = null, val userMessageTextColor: String? = null, val botMessageBackground: String? = null, val botMessageTextColor: String? = null)

Style data for events

KindlyEventType

enum KindlyEventType : Enum<KindlyEventType>

Types of events that can be emitted by the Kindly SDK

KindlyEventUIAction

data class KindlyEventUIAction(val type: KindlyUIActionType, val source: String = "user", val chatId: String, val value: Map<String, Any>? = null, val feedbackType: String? = null, val feedbackValue: Map<String, Any>? = null, val languageCode: String? = null, val languageName: String? = null, val previousLanguageCode: String? = null, val previousLanguageName: String? = null, val nextPage: String? = null)

UI action data for events

KindlyUIActionType

enum KindlyUIActionType : Enum<KindlyUIActionType>

Types of UI actions that can be performed