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

Package-level declarations

Types

ChangeLanguageButtonSDK

@Serializable

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

ChangeLanguageTextSDK

@Serializable

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

ChatBubbleDataSDK

@Serializable

data class ChatBubbleDataSDK(val domains: List<String>?, val key: String?, val realtimeAnalytics: Boolean?, val heartbeatEnabled: Boolean?, val heartbeatTtlS: Int?, val iconAvatarImage: String?, val persistState: Boolean?, val persistStateLifespanSeconds: Int?, val autopopup: Boolean?, val autopopupTime: Int?, val keepOpen: Boolean?, val keepOpenMobile: Boolean?, val inputLimitEnabled: Boolean?, val inputLimit: Int?, val authPublicKey: String?)

ComplianceSettingsForLanguageSDK

@Serializable

data class ComplianceSettingsForLanguageSDK(val enabled: Boolean?, val requireAgreement: Boolean?, val descriptionTextHtml: String?, val buttonText: String?, val acceptanceText: String?, val revokePermissionText: String?, val accessRequestText: String?)

ComplianceSettingsSDK

@Serializable(with = ComplianceSettingsSDKSerializer::class)

data class ComplianceSettingsSDK(val languageSettings: Map<String, ComplianceSettingsForLanguageSDK>)

ComplianceSettingsSDKSerializer

object ComplianceSettingsSDKSerializer : KSerializer<ComplianceSettingsSDK>

DeleteButtonSDK

@Serializable

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

DeleteTextSDK

@Serializable

data class DeleteTextSDK(var en: String?, var nb: String?, var nn: String?, var sv: String?)

DownloadButtonSDK

@Serializable

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

DownloadFormatTextSDK

@Serializable

data class DownloadFormatTextSDK(val en: String?, val es: String?, val fr: String?, val nb: String?, val nn: String?, val sv: String?)

EditLabelSDK

@Serializable

data class EditLabelSDK(val id: String?, val image: String?, val rating: String?, val sentiment: String?, val showRating: Boolean?)

FeedbackFormDataSDK

@Serializable

data class FeedbackFormDataSDK(val id: String?, val isActive: Boolean?, val formTitle: String?, val headline: String?, val buttonLabel: String?, val nextButton: String?, val backButton: String?, val sendButton: String?, val thanksText: String?, val feedbackType: String?, val triggerType: TriggerTypeSDK?, val ratingScale: RatingScaleSDK?, val predefinedButtons: PredefinedButtonsSDK?, val freeForm: FreeFormSDK?, val urlForFeedback: String?, val allowBotFeedbackAfterHandoverFeedback: Boolean?)

FreeFormSDK

@Serializable

data class FreeFormSDK(val title: String?, val enableStep: Boolean?, val placeholder: String?)

LanguageFeedbackSettingSDK

@Serializable

data class LanguageFeedbackSettingSDK(val id: String?, val forms: List<FeedbackFormDataSDK>?)

LanguagesDataSDK

@Serializable

data class LanguagesDataSDK(var code: String?, var name: String?, var active: Boolean?)

LanguagesDataSDK contains data of the settings languages

MaintenanceAlertSDK

@Serializable

data class MaintenanceAlertSDK(val alertEnabled: Boolean?, val linkText: TextPlaceholderSDK?, val linkLocation: TextPlaceholderSDK?, val textContent: TextPlaceholderSDK?)

NotificationsDataSDK

@Serializable

data class NotificationsDataSDK(val tabNotification: Boolean?, val soundNotification: Boolean?, val bubbleNotification: Boolean?, val usePushGreetings: Boolean?, val pushGreetings: List<NotificationsPushGreetingsDataSDK>?)

NotificationsPushGreetingsDataSDK

@Serializable

data class NotificationsPushGreetingsDataSDK(val enabled: Map<String, Boolean>?, val title: Map<String, String>?, val url: String?, val message: Map<String, String>?, val autopopupTime: Int?)

PredefinedButtonsSDK

@Serializable

data class PredefinedButtonsSDK(val rawSentiments: Map<String, SentimentDataSDK>?, val enableStep: Boolean?, val useSentimentButtons: Boolean?)

RatingScaleSDK

@Serializable

data class RatingScaleSDK(val title: String?, val editLabels: List<EditLabelSDK>?, val ratingSystem: Int?)

SentimentButtonDataSDK

@Serializable

data class SentimentButtonDataSDK(val id: String?, val text: String?)

SentimentDataSDK

@Serializable

data class SentimentDataSDK(val title: String?, val buttons: List<SentimentButtonDataSDK>?)

SentimentKey

sealed class SentimentKey

SettingsDataSDK

@Serializable

data class SettingsDataSDK(val id: Int?, val name: String?, val languages: List<LanguagesDataSDK>?, val supportedLanguages: List<SupportedLanguageDataSDK>?, val liveTranslationLanguageCodes: List<String>?, val avatar: String?, val bubbleSize: String?, val useBubbleOutline: Boolean?, val typingIndicator: Boolean?, val typingDuration: Int?, val disabledTransports: List<String>?, val userIdleTimeoutSeconds: Int?, val updatedAt: String?, val showTakeoverQueue: Boolean?, val noFeedbackAfterHandover: Boolean?, val handoverMode: String?, val chatbubbleHeartbeatEnabled: Boolean?, val chatbubbleHeartbeatTtlS: Int?, val textRightToLeft: Boolean?, val feedbackSettings: Map<String, LanguageFeedbackSettingSDK>?, val complianceSettings: ComplianceSettingsSDK?)

SettingsDataSDK backend configurations for chat Kindly SDK

SettingsResponse

@Serializable

data class SettingsResponse(val settings: SettingsDataSDK, val style: StyleDataSDK, val text: TextResourcesSDK, val maintenanceAlert: MaintenanceAlertSDK?, val notifications: NotificationsDataSDK?, val welcomePage: WelcomePageDataSDK?, val chatBubble: ChatBubbleDataSDK?, val feedbackForm: FeedbackFormDataSDK?)

Setting response

StartOverButtonSDK

@Serializable

data class StartOverButtonSDK(val en: String? = null, val nb: String? = null, val nn: String? = null, val sv: String? = null)

StyleDataSDK

@Serializable

data class StyleDataSDK(val colorButtonOutline: String?, val colorChatLogElements: String?, val colorButtonBackground: String?, val colorBubbleButtonBackground: String?, val colorButtonText: String?, val colorBackground: String?, val colorHeaderBackground: String?, val colorHeaderText: String?, val colorInputBackground: String?, val colorInputText: String?, val colorUserMessageBackground: String?, val colorUserMessageTextColor: String?, val colorBotMessageBackground: String?, val colorBotMessageTextColor: String?)

StyleDataSDK backend styles configurations for chat Kindly SDK

SupportedLanguageDataSDK

@Serializable

data class SupportedLanguageDataSDK(val code: String?, val nameLocal: String?, val nameEnglish: String?, val isActive: Boolean?, val isPrimary: Boolean?, val isLiveTranslation: Boolean?)

SupportedLanguageDataSDK enhanced language data with live translation support

TextPlaceholderSDK

@Serializable(with = TextPlaceholderSDKSerializer::class)

data class TextPlaceholderSDK(translations: Map<String, String> = emptyMap())

Dynamic TextPlaceholderSDK that supports ANY language from server without hardcoded fields. This works like iOS - fully dynamic based on server response.

TextPlaceholderSDKSerializer

object TextPlaceholderSDKSerializer : KSerializer<TextPlaceholderSDK>

TextResourcesSDK

@Serializable

data class TextResourcesSDK(val placeholder: TextPlaceholderSDK?, val changeLanguageButton: TextPlaceholderSDK?, val startOverButton: TextPlaceholderSDK?, val downloadButton: TextPlaceholderSDK?, val downloadFormatText: TextPlaceholderSDK?, val deleteButton: TextPlaceholderSDK?, val deleteText: TextPlaceholderSDK?, val changeLanguageText: TextPlaceholderSDK?, val cancelChatText: TextPlaceholderSDK?, val cancelChatButton: TextPlaceholderSDK?, val confirmActionButton: TextPlaceholderSDK?, val chatSettings: TextPlaceholderSDK?, val settingsButton: TextPlaceholderSDK? = null, val cancelButton: TextPlaceholderSDK? = null, val handoverQueueText: TextPlaceholderSDK?, val handoverQueueLink: TextPlaceholderSDK?, val takeoverQueueText: TextPlaceholderSDK?, val takeoverQueueLink: TextPlaceholderSDK?, val leaveQueueText: TextPlaceholderSDK?, val leaveQueueLink: TextPlaceholderSDK?, val chattingWithAgentText: TextPlaceholderSDK?, val userEndHandoverButtonText: TextPlaceholderSDK?, val userEndHandoverModalTitleText: TextPlaceholderSDK?, val userEndHandoverModalDescriptionText: TextPlaceholderSDK?, val agentJoinedText: TextPlaceholderSDK?, val agentLeftText: TextPlaceholderSDK?, val queuePositionText: TextPlaceholderSDK?, val estimatedTimeText: TextPlaceholderSDK?)

TriggerTypeSDK

@Serializable

enum TriggerTypeSDK : Enum<TriggerTypeSDK>

WelcomePageDataSDK

@Serializable

data class WelcomePageDataSDK(val image: String?, val type: String?, val header: Map<String, String>?, val text: Map<String, String>?, val startButton: Map<String, String>?)

Functions

feedbackForm

fun Map<String, LanguageFeedbackSettingSDK>.feedbackForm(triggerType: TriggerTypeSDK): FeedbackFormDataSDK?