kindlysdk/no.kindly.chatsdk.chat.sdk.data.entity

Package-level declarations

Types

@Serializable

data class BotModel(val id: String = "", val name: String = "", val avatarURL: String? = null, val shouldDisplayTypingIndicator: Boolean = true)

Model representing a bot's information. Matches the iOS Bot model structure.

BotPlaceholder

@Serializable

data class BotPlaceholder(val en: String?, val nb: String?, val nn: String?, val sv: String?)

ButtonAction

@Serializable

data class ButtonAction(val button: ButtonDataSDK, val chatMessage: MessageData, val temporaryId: String? = "709a5ba6-7d7c-484d-98d4-57488917abf1", val version: String = "2.36.1", val newContext: Map<String, String>? = LifecycleVars.kindlyContext)

ButtonDataSDK

@Serializable

data class ButtonDataSDK(val id: String?, val buttonType: String?, val languageCode: String?, val label: String = "", val value: String?, val index: Int?, val createdAt: String?, val updatedAt: String?, val isActive: Boolean = true, val hideOutsideBusinessHours: Boolean?, val context: Map<String, Any>? = null)

ChatMessageReferenceModel

@Serializable

data class ChatMessageReferenceModel(val url: String, val offset: Int, val _id: String)

Connection

@Serializable

data class Connection(val bot: BotModel, val token: String = "", val chatId: String = "")

Connection model similar to iOS implementation

ConnectiondData

@Serializable

data class ConnectiondData(val chatId: String?, val created: String?, val token: String = "", val botName: String = "", val botAvatar: String?, val botTypingDuration: Int = 0, val botTypingIndicator: Boolean?, val allGreetingsHideInput: Boolean?)

ConnectionResponse

@Serializable

data class ConnectionResponse(val chatId: String?, val created: String?, val token: String = "", val botName: String = "", val botAvatar: String = "", val botTypingDuration: Int = 0, val botTypingIndicator: Boolean?, val botPlaceholder: BotPlaceholder?, val allGreetingsHideInput: Boolean?, val greeting: MessageData?, val liveTranslationSystemDialogue: MessageData?)

ConnectModel

@Serializable

data class ConnectModel(val context: Map<String, String>? = LifecycleVars.kindlyContext)

Format

enum Format : Enum<Format>

FormFieldAttributesDTO

@Serializable

data class FormFieldAttributesDTO(val step: Double?, val options: List<FormFieldOptionDTO>?, val maxFiles: Int? = null)

FormFieldDTO

@Serializable

data class FormFieldDTO(val inputType: FormFieldInputType, val required: Boolean, val order: Int, val slug: String, val texts: FormFieldTextsDTO, val attributes: FormFieldAttributesDTO?, val validators: List<FormFieldValidatorDTO>?)

FormFieldInputType

@Serializable

enum FormFieldInputType : Enum<FormFieldInputType>

FormFieldOptionDTO

@Serializable

data class FormFieldOptionDTO(val id: String?, val label: String, val value: String)

FormFieldTextsDTO

@Serializable

data class FormFieldTextsDTO(val label: String, val placeholderText: String?, val helpText: String?)

FormFieldValidatorDTO

@Serializable

data class FormFieldValidatorDTO(val minimum: Int? = null, val maximum: Int? = null, val minLength: Int? = null, val maxLength: Int? = null, rawPattern: String? = null)

FormSDK

@Serializable

data class FormSDK(val id: String, val createdAt: String, val updatedAt: String, val submitDialogueId: String, val cancelDialogueId: String, val languageCode: String, val texts: FormTextsDTO, val fields: List<FormFieldDTO>, val submissionId: String, var state: MutableStateFlow<FormState>? = MutableStateFlow(FormState.ACTIVE), var submittedFields: Map<String, String> = emptyMap())

FormTextsDTO

@Serializable

data class FormTextsDTO(val title: String?, val submitButtonText: String, val cancelButtonText: String, val cancelText: String, val errorText: String, val unansweredText: String)

ImageItem

@Serializable

data class ImageItem(val id: String?, val imageUrl: String? = "", val title: String?, val description: String?, val altText: String?, val newTab: Boolean?, val linkUrl: String?, val buttons: List<ButtonDataSDK>? = null)

Image object

LanguageSwitchRequest

@Serializable

data class LanguageSwitchRequest(val languageCode: String)

MessageActionResponse

@Serializable

data class MessageActionResponse(val chatmessageId: String?)

MessageData

@Serializable

data class MessageData(val sessionId: String?, val botId: Int?, val chatId: String?, val chatSource: String?, val chatLanguageCode: String?, val fromBot: Boolean?, val sender: String?, val replyToId: String?, val lastUserMessageId: String?, val skillSubscriptionId: String?, val isFollowup: Boolean?, val message: String?, val messageFormat: String?, val attachments: List<String>? = listOf(), val attachmentIds: List<String>? = listOf(), val messageWithKindlyEntities: String?, val labelsTriggered: List<String>? = listOf(), val imageCarousel: List<ImageCarouselSDK>? = listOf(), val imageCarouselSize: Int?, val urlTrigger: String?, val videoSource: String?, val thonImageAboveText: Boolean?, val buttons: List<ButtonDataSDK>? = listOf(), val exchangeType: String?, val exchangeId: String?, val title: String?, val parentExchangeId: String?, val chatbubbleHideInputField: Boolean?, val webhookUrl: String?, val score: Double?, val handler: String?, val triggeredChatStart: Boolean?, val replyType: String?, val fromWebhook: Boolean?, val agentJoined: Boolean?, val suggestions: List<SuggestionSDK>? = listOf(), val emailReferences: List<String>? = listOf(), val emailFrom: List<String>? = listOf(), val emailTo: List<String>? = listOf(), val emailCc: List<String>? = listOf(), val created: String?, val v: Int?, val id: String?, val systemDialogMessageType: String?, val duringBusinessHours: Boolean?, val handoverRequestWhenTriggered: Boolean?, val name: String?, val avatar: String?, val systemDialogueCategory: String?, val form: FormSDK?, val messageReferences: List<ChatMessageReferenceModel>? = listOf(), val eventMessage: String?)

MessageResponse

@Serializable

data class MessageResponse(val created: String = "", val id: String = "", val temporaryId: String = "")

MessageSDK

@Serializable

data class MessageSDK(val systemDialogMessageType: SystemDialogueMessageType?, val sessionId: String? = null, val botId: Int?, val chatId: String?, val chatSource: String?, val chatLanguageCode: String?, val fromBot: Boolean?, val sender: String?, val replyToId: String?, val lastUserMessageId: String?, val skillSubscriptionId: String?, val isFollowup: Boolean?, val message: String?, val messageFormat: MessageFormatType?, val attachments: List<String> = listOf(), val attachmentIds: List<String>? = listOf(), val messageWithKindlyEntities: String?, val labelsTriggered: List<String> = listOf(), val imageCarousel: List<ImageItem>? = listOf(), val imageCarouselSize: Int?, val urlTrigger: String?, val videoSource: String?, val thonImageAboveText: Boolean?, val buttons: List<ButtonSDK> = listOf(), val exchangeType: String?, val exchangeId: String?, val title: String?, val parentExchangeId: String?, val chatbubbleHideInputField: Boolean?, val webhookUrl: String?, val score: Double?, val handler: String?, val triggeredChatStart: Boolean?, val replyType: String?, val fromWebhook: Boolean?, val agentJoined: Boolean?, val suggestions: List<SuggestionSDK> = listOf(), val emailReferences: List<String>? = listOf(), val emailFrom: List<String>? = listOf(), val emailTo: List<String>? = listOf(), val emailCc: List<String>? = listOf(), val created: String?, val v: Int?, val id: String?, val isMine: Boolean = true, val newContext: Map<String, String>? = LifecycleVars.kindlyContext, val duringBusinessHours: Boolean?, val handoverRequestWhenTriggered: Boolean?, val name: String?, val avatar: String?, val systemDialogueCategory: SystemDialogueCategoryType?, val form: FormSDK?, val messageReferences: List<ChatMessageReferenceModel>? = listOf(), val eventMessage: String?, val temporaryId: String? = null)

NotificationPayload

@Serializable

data class NotificationPayload(val msgcnt: String? = null, var body: String? = null, val sound: String? = null, var message: String? = null, val notificationSource: String? = null, var title: String? = null, val messageId: String? = null, val created: String = MessageTimeHelper.getISO8601StringForCurrentDate())

NotificationServiceRequestModel

@Serializable

data class NotificationServiceRequestModel(var notificationToken: String, var bundleId: String = "no.kindly.chatsdk.chat", var isProduction: Boolean = true)

NotificationServiceResponseModel

@Serializable

data class NotificationServiceResponseModel(val id: Int? = null, val encryptionKey: String? = null, val encryptionIV: String? = null)

OEmbedData

@Serializable

data class OEmbedData(val height: Int? = null, val width: Int? = null, var html: String? = null, val providerUrl: String? = null, val title: String? = null) : Parcelable

PostMessageResponse

@Serializable

data class PostMessageResponse(val chatId: String?, val created: String?, val token: String = "")

TakeoverData

@Serializable

data class TakeoverData(val hasRequestedTakeover: Boolean?, val takeOver: Boolean?, val avatar: String?, val name: String?, val supportsAttachments: Boolean?, val handoverQueuePosition: Int?, val handoverWaitTimeEstimate: Int?)

TriggerDialogueRequest

@Serializable

data class TriggerDialogueRequest(val exchangeId: String)

Properties

dummyMessageReferences

val dummyMessageReferences: List<ChatMessageReferenceModel>