sdk (4 of 5)
DownloadFormatTextSDK
data class
@Serializable
data class DownloadFormatTextSDK(val en: String?, val es: String?, val fr: String?, val nb: String?, val nn: String?, val sv: String?)Member | Declaration | Description |
|---|---|---|
DownloadFormatTextSDK | constructor(en: String?, es: String?, fr: String?, nb: String?, nn: String?, sv: String?) | |
en | @SerialName(value = "en") val en: String? | |
es | @SerialName(value = "es") val es: String? | |
fr | @SerialName(value = "fr") val fr: String? | |
nb | @SerialName(value = "nb") val nb: String? | |
nn | @SerialName(value = "nn") val nn: String? | |
sv | @SerialName(value = "sv") val sv: String? | |
EditLabelSDK
data class
@Serializable
data class EditLabelSDK(val id: String?, val image: String?, val rating: String?, val sentiment: String?, val showRating: Boolean?)Member | Declaration | Description |
|---|---|---|
EditLabelSDK | constructor(id: String?, image: String?, rating: String?, sentiment: String?, showRating: Boolean?) | |
accessibilityId | val accessibilityId: String | Generates a unique accessibility identifier for Appium automation Format: rating_label_id``rating``sentiment |
id | val id: String? | |
image | val image: String? | |
rating | val rating: String? | |
sentiment | val sentiment: String? | |
showRating | @SerialName(value = "show_rating") val showRating: Boolean? | |
feedbackForm
function
fun Map<String, LanguageFeedbackSettingSDK>.feedbackForm(triggerType: TriggerTypeSDK): FeedbackFormDataSDK?FeedbackFormDataSDK
data class
@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?)Member | Declaration | Description |
|---|---|---|
FeedbackFormDataSDK | constructor(id: String?, isActive: Boolean?, formTitle: String?, headline: String?, buttonLabel: String?, nextButton: String?, backButton: String?, sendButton: String?, thanksText: String?, feedbackType: String?, triggerType: TriggerTypeSDK?, ratingScale: RatingScaleSDK?, predefinedButtons: PredefinedButtonsSDK?, freeForm: FreeFormSDK?, urlForFeedback: String?, allowBotFeedbackAfterHandoverFeedback: Boolean?) | |
accessibilityId | val accessibilityId: String | Generates a unique accessibility identifier for Appium automation Format: feedback_form_id_formTitle |
allowBotFeedbackAfterHandoverFeedback | @SerialName(value = "allow_bot_feedback_after_handover_feedback") val allowBotFeedbackAfterHandoverFeedback: Boolean? | |
backButton | @SerialName(value = "back_button") val backButton: String? | |
buttonLabel | @SerialName(value = "button_label") val buttonLabel: String? | |
feedbackType | @SerialName(value = "feedback_type") val feedbackType: String? | |
formTitle | @SerialName(value = "form_title") val formTitle: String? | |
freeForm | @SerialName(value = "free_form") val freeForm: FreeFormSDK? | |
headline | val headline: String? | |
id | val id: String? | |
isActive | @SerialName(value = "is_active") val isActive: Boolean? | |
nextButton | @SerialName(value = "next_button") val nextButton: String? | |
predefinedButtons | @SerialName(value = "predefined_buttons") val predefinedButtons: PredefinedButtonsSDK? | |
ratingScale | @SerialName(value = "rating_scale") val ratingScale: RatingScaleSDK? | |
sendButton | @SerialName(value = "send_button") val sendButton: String? | |
thanksText | @SerialName(value = "thanks_text") val thanksText: String? | |
triggerType | @SerialName(value = "trigger_type") val triggerType: TriggerTypeSDK? | |
urlForFeedback | @SerialName(value = "url_for_feedback") val urlForFeedback: String? | |
FreeFormSDK
data class
@Serializable
data class FreeFormSDK(val title: String?, val enableStep: Boolean?, val placeholder: String?)Member | Declaration | Description |
|---|---|---|
FreeFormSDK | constructor(title: String?, enableStep: Boolean?, placeholder: String?) | |
accessibilityId | val accessibilityId: String | Generates a unique accessibility identifier for Appium automation Format: free_form_title |
enableStep | @SerialName(value = "enable_step") val enableStep: Boolean? | |
placeholder | val placeholder: String? | |
title | val title: String? | |
LanguageFeedbackSettingSDK
data class
@Serializable
data class LanguageFeedbackSettingSDK(val id: String?, val forms: List<FeedbackFormDataSDK>?)Member | Declaration | Description |
|---|---|---|
LanguageFeedbackSettingSDK | constructor(id: String?, forms: List<FeedbackFormDataSDK>?) | |
forms | val forms: List<FeedbackFormDataSDK>? | |
id | val id: String? | |
LanguagesDataSDK
data class
@Serializable
data class LanguagesDataSDK(var code: String?, var name: String?, var active: Boolean?)LanguagesDataSDK contains data of the settings languages
Member | Declaration | Description |
|---|---|---|
LanguagesDataSDK | constructor(code: String?, name: String?, active: Boolean?) | |
active | @SerialName(value = "active") var active: Boolean? | |
code | @SerialName(value = "code") var code: String? | |
name | @SerialName(value = "name") var name: String? | |
MaintenanceAlertSDK
data class
@Serializable
data class MaintenanceAlertSDK(val alertEnabled: Boolean?, val linkText: TextPlaceholderSDK?, val linkLocation: TextPlaceholderSDK?, val textContent: TextPlaceholderSDK?)Member | Declaration | Description |
|---|---|---|
MaintenanceAlertSDK | constructor(alertEnabled: Boolean?, linkText: TextPlaceholderSDK?, linkLocation: TextPlaceholderSDK?, textContent: TextPlaceholderSDK?) | |
alertEnabled | @SerialName(value = "alert_enabled") val alertEnabled: Boolean? | |
linkLocation | @SerialName(value = "link_location") val linkLocation: TextPlaceholderSDK? | |
linkText | @SerialName(value = "link_text") val linkText: TextPlaceholderSDK? | |
textContent | @SerialName(value = "text_content") val textContent: TextPlaceholderSDK? | |
NotificationsDataSDK
data class
@Serializable
data class NotificationsDataSDK(val tabNotification: Boolean?, val soundNotification: Boolean?, val bubbleNotification: Boolean?, val usePushGreetings: Boolean?, val pushGreetings: List<NotificationsPushGreetingsDataSDK>?)Member | Declaration | Description |
|---|---|---|
NotificationsDataSDK | constructor(tabNotification: Boolean?, soundNotification: Boolean?, bubbleNotification: Boolean?, usePushGreetings: Boolean?, pushGreetings: List<NotificationsPushGreetingsDataSDK>?) | |
bubbleNotification | @SerialName(value = "bubble_notification") val bubbleNotification: Boolean? | |
pushGreetings | @SerialName(value = "push_greetings") val pushGreetings: List<NotificationsPushGreetingsDataSDK>? | |
soundNotification | @SerialName(value = "sound_notification") val soundNotification: Boolean? | |
tabNotification | @SerialName(value = "tab_notification") val tabNotification: Boolean? | |
usePushGreetings | @SerialName(value = "use_push_greetings") val usePushGreetings: Boolean? | |
NotificationsPushGreetingsDataSDK
data class
@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?)Member | Declaration | Description |
|---|---|---|
NotificationsPushGreetingsDataSDK | constructor(enabled: Map<String, Boolean>?, title: Map<String, String>?, url: String?, message: Map<String, String>?, autopopupTime: Int?) | |
autopopupTime | @SerialName(value = "autopopup_time") val autopopupTime: Int? | |
enabled | val enabled: Map<String, Boolean>? | |
message | val message: Map<String, String>? | |
title | val title: Map<String, String>? | |
url | val url: String? | |
PredefinedButtonsSDK
data class
@Serializable
data class PredefinedButtonsSDK(val rawSentiments: Map<String, SentimentDataSDK>?, val enableStep: Boolean?, val useSentimentButtons: Boolean?)Member | Declaration | Description |
|---|---|---|
PredefinedButtonsSDK | constructor(rawSentiments: Map<String, SentimentDataSDK>?, enableStep: Boolean?, useSentimentButtons: Boolean?) | |
enableStep | @SerialName(value = "enable_step") val enableStep: Boolean? | |
rawSentiments | @SerialName(value = "sentiments") val rawSentiments: Map<String, SentimentDataSDK>? | |
useSentimentButtons | @SerialName(value = "use_sentiment_buttons") val useSentimentButtons: Boolean? | |
RatingScaleSDK
data class
@Serializable
data class RatingScaleSDK(val title: String?, val editLabels: List<EditLabelSDK>?, val ratingSystem: Int?)Member | Declaration | Description |
|---|---|---|
RatingScaleSDK | constructor(title: String?, editLabels: List<EditLabelSDK>?, ratingSystem: Int?) | |
accessibilityId | val accessibilityId: String | Generates a unique accessibility identifier for Appium automation Format: rating_scale_ratingSystem_title |
editLabels | @SerialName(value = "edit_labels") val editLabels: List<EditLabelSDK>? | |
ratingSystem | @SerialName(value = "rating_system") val ratingSystem: Int? | |
title | val title: String? | |
SentimentButtonDataSDK
data class
@Serializable
data class SentimentButtonDataSDK(val id: String?, val text: String?)Member | Declaration | Description |
|---|---|---|
SentimentButtonDataSDK | constructor(id: String?, text: String?) | |
accessibilityId | val accessibilityId: String | Generates a unique accessibility identifier for Appium automation Format: sentiment_button_id_text |
id | val id: String? | |
text | val text: String? | |
SentimentDataSDK
data class
@Serializable
data class SentimentDataSDK(val title: String?, val buttons: List<SentimentButtonDataSDK>?)Member | Declaration | Description |
|---|---|---|
SentimentDataSDK | constructor(title: String?, buttons: List<SentimentButtonDataSDK>?) | |
buttons | val buttons: List<SentimentButtonDataSDK>? | |
title | val title: String? | |
SentimentKey
sealed class
sealed class SentimentKeyMember | Declaration | Description |
|---|---|---|
stringValue | val stringValue: String | |
SentimentKey.Companion
object
object CompanionMember | Declaration | Description |
|---|---|---|
fromString | fun fromString(key: String): SentimentKey | |
SentimentKey.Negative
object
object Negative : SentimentKeySentimentKey.Neutral
object
object Neutral : SentimentKeySentimentKey.NoSentiment
object
object NoSentiment : SentimentKeySentimentKey.Positive
object
object Positive : SentimentKeySentimentKey.Unknown
data class
data class Unknown(val key: String = "") : SentimentKeyMember | Declaration | Description |
|---|---|---|
Unknown | constructor(key: String = "") | |
key | val key: String | |
SettingsDataSDK
data class
@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
Member | Declaration | Description |
|---|---|---|
SettingsDataSDK | constructor(id: Int?, name: String?, languages: List<LanguagesDataSDK>?, supportedLanguages: List<SupportedLanguageDataSDK>?, liveTranslationLanguageCodes: List<String>?, avatar: String?, bubbleSize: String?, useBubbleOutline: Boolean?, typingIndicator: Boolean?, typingDuration: Int?, disabledTransports: List<String>?, userIdleTimeoutSeconds: Int?, updatedAt: String?, showTakeoverQueue: Boolean?, noFeedbackAfterHandover: Boolean?, handoverMode: String?, chatbubbleHeartbeatEnabled: Boolean?, chatbubbleHeartbeatTtlS: Int?, textRightToLeft: Boolean?, feedbackSettings: Map<String, LanguageFeedbackSettingSDK>?, complianceSettings: ComplianceSettingsSDK?) | |
avatar | @SerialName(value = "avatar") val avatar: String? | |
bubbleSize | @SerialName(value = "bubble_size") val bubbleSize: String? | |
chatbubbleHeartbeatEnabled | @SerialName(value = "chatbubble_heartbeat_enabled") val chatbubbleHeartbeatEnabled: Boolean? | |
chatbubbleHeartbeatTtlS | @SerialName(value = "chatbubble_heartbeat_ttl_s") val chatbubbleHeartbeatTtlS: Int? | |
complianceSettings | @SerialName(value = "compliance_settings") val complianceSettings: ComplianceSettingsSDK? | |
disabledTransports | @SerialName(value = "disabled_transports") val disabledTransports: List<String>? | |
feedbackSettings | @SerialName(value = "feedback_settings") val feedbackSettings: Map<String, LanguageFeedbackSettingSDK>? | |
handoverMode | @SerialName(value = "handover_mode") val handoverMode: String? | |
id | @SerialName(value = "id") val id: Int? | |
languages | @SerialName(value = "languages") val languages: List<LanguagesDataSDK>? | |
liveTranslationLanguageCodes | @SerialName(value = "live_translation_language_codes") val liveTranslationLanguageCodes: List<String>? | |
name | @SerialName(value = "name") val name: String? | |
noFeedbackAfterHandover | @SerialName(value = "no_feedback_after_handover") val noFeedbackAfterHandover: Boolean? | |
showTakeoverQueue | @SerialName(value = "show_takeover_queue") val showTakeoverQueue: Boolean? | |
supportedLanguages | @SerialName(value = "supported_languages") val supportedLanguages: List<SupportedLanguageDataSDK>? | |
textRightToLeft | @SerialName(value = "text_right_to_left") val textRightToLeft: Boolean? | |
typingDuration | @SerialName(value = "typing_duration") val typingDuration: Int? | |
typingIndicator | @SerialName(value = "typing_indicator") val typingIndicator: Boolean? | |
updatedAt | @SerialName(value = "updated_at") val updatedAt: String? | |
useBubbleOutline | @SerialName(value = "use_bubble_outline") val useBubbleOutline: Boolean? | |
userIdleTimeoutSeconds | @SerialName(value = "user_idle_timeout_seconds") val userIdleTimeoutSeconds: Int? | |
SettingsResponse
data class
@Serializable
data class SettingsResponse(val settings: SettingsDataSDK, val style: StyleDataSDK, val text: TextResourcesSDK? = null, val maintenanceAlert: MaintenanceAlertSDK? = null, val notifications: NotificationsDataSDK? = null, val welcomePage: WelcomePageDataSDK? = null, val chatBubble: ChatBubbleDataSDK? = null, val feedbackForm: FeedbackFormDataSDK? = null, val locales: Map<String, Map<String, String>>? = null)The settings payload.
Every optional block carries = null rather than relying on the key being present. kotlinx treats a nullable field with no default as required, so without this the platform removing any one of them fails the whole decode and the chat never loads. That matters now because the backend team expects to deprecate text. Pinned by SettingsDecodingResilienceTest.
Member | Declaration | Description |
|---|---|---|
SettingsResponse | constructor(settings: SettingsDataSDK, style: StyleDataSDK, text: TextResourcesSDK? = null, maintenanceAlert: MaintenanceAlertSDK? = null, notifications: NotificationsDataSDK? = null, welcomePage: WelcomePageDataSDK? = null, chatBubble: ChatBubbleDataSDK? = null, feedbackForm: FeedbackFormDataSDK? = null, locales: Map<String, Map<String, String>>? = null) | |
chatBubble | @SerialName(value = "chatbubble") val chatBubble: ChatBubbleDataSDK? | |
feedbackForm | @SerialName(value = "feedback_form") val feedbackForm: FeedbackFormDataSDK? | |
locales | @SerialName(value = "locales") val locales: Map<String, Map<String, String>>? | Per-language string table keyed by language code, then by dotted key (locales["nb"]["handover.chatting_with_agent"]). Values may contain {placeholder} tokens the client substitutes. Newer and broader than chatbubble's text_content: it is the only place the platform publishes a translated "unknown agent" wording, and its handover strings keep {agentName} in the position that language needs rather than assuming the name goes last. The SDK reads only the handover keys today - see LanguageConfigs.handoverHeaderTitle. |
maintenanceAlert | @SerialName(value = "maintenance_alert") val maintenanceAlert: MaintenanceAlertSDK? | |
notifications | @SerialName(value = "notifications") val notifications: NotificationsDataSDK? | |
settings | @SerialName(value = "settings") val settings: SettingsDataSDK | |
style | @SerialName(value = "style") val style: StyleDataSDK | |
text | @SerialName(value = "text") val text: TextResourcesSDK? | The legacy string block, superseded by locales. Optional because the backend team expects to deprecate it; a required field here would turn that deprecation into a total decode failure for every shipped client. See SettingsDecodingResilienceTest. |
welcomePage | @SerialName(value = "welcome_page") val welcomePage: WelcomePageDataSDK? | |
StartOverButtonSDK
data class
@Serializable
data class StartOverButtonSDK(val en: String? = null, val nb: String? = null, val nn: String? = null, val sv: String? = null)Member | Declaration | Description |
|---|---|---|
StartOverButtonSDK | constructor(en: String? = null, nb: String? = null, nn: String? = null, sv: String? = null) | |
en | @SerialName(value = "en") val en: String? | |
nb | @SerialName(value = "nb") val nb: String? | |
nn | @SerialName(value = "nn") val nn: String? | |
sv | @SerialName(value = "sv") val sv: String? | |
StyleDataSDK
data class
@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
Member | Declaration | Description |
|---|---|---|
StyleDataSDK | constructor(colorButtonOutline: String?, colorChatLogElements: String?, colorButtonBackground: String?, colorBubbleButtonBackground: String?, colorButtonText: String?, colorBackground: String?, colorHeaderBackground: String?, colorHeaderText: String?, colorInputBackground: String?, colorInputText: String?, colorUserMessageBackground: String?, colorUserMessageTextColor: String?, colorBotMessageBackground: String?, colorBotMessageTextColor: String?) | |
colorBackground | @SerialName(value = "color_background") val colorBackground: String? | |
colorBotMessageBackground | @SerialName(value = "color_bot_message_background") val colorBotMessageBackground: String? | |
colorBotMessageTextColor | @SerialName(value = "color_bot_message_text_color") val colorBotMessageTextColor: String? | |
colorBubbleButtonBackground | @SerialName(value = "color_bubble_button_background") val colorBubbleButtonBackground: String? | |
colorButtonBackground | @SerialName(value = "color_button_background") val colorButtonBackground: String? | |
colorButtonOutline | @SerialName(value = "color_button_outline") val colorButtonOutline: String? | |
colorButtonText | @SerialName(value = "color_button_text") val colorButtonText: String? | |
colorChatLogElements | @SerialName(value = "color_chat_log_elements") val colorChatLogElements: String? | |
colorHeaderBackground | @SerialName(value = "color_header_background") val colorHeaderBackground: String? | |
colorHeaderText | @SerialName(value = "color_header_text") val colorHeaderText: String? | |
colorInputBackground | @SerialName(value = "color_input_background") val colorInputBackground: String? | |
colorInputText | @SerialName(value = "color_input_text") val colorInputText: String? | |
colorUserMessageBackground | @SerialName(value = "color_user_message_background") val colorUserMessageBackground: String? | |
colorUserMessageTextColor | @SerialName(value = "color_user_message_text_color") val colorUserMessageTextColor: String? | |
SupportedLanguageDataSDK
data class
@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
Member | Declaration | Description |
|---|---|---|
SupportedLanguageDataSDK | constructor(code: String?, nameLocal: String?, nameEnglish: String?, isActive: Boolean?, isPrimary: Boolean?, isLiveTranslation: Boolean?) | |
code | @SerialName(value = "code") val code: String? | |
isActive | @SerialName(value = "is_active") val isActive: Boolean? | |
isLiveTranslation | @SerialName(value = "is_live_translation") val isLiveTranslation: Boolean? | |
isPrimary | @SerialName(value = "is_primary") val isPrimary: Boolean? | |
nameEnglish | @SerialName(value = "name_english") val nameEnglish: String? | |
nameLocal | @SerialName(value = "name_local") val nameLocal: String? | |
toLanguagesDataSDK | fun toLanguagesDataSDK(): LanguagesDataSDK | Convert to LanguagesDataSDK for backward compatibility |
TextPlaceholderSDK
data class
@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.
Member | Declaration | Description |
|---|---|---|
TextPlaceholderSDK | constructor(translations: Map<String, String> = emptyMap()) | |
get | fun get(languageCode: String): String? | Get translation for a specific language code |
getAvailableLanguages | fun getAvailableLanguages(): Set<String> | Get all available language codes |
getWithFallback | fun getWithFallback(languageCode: String): String? | Get translation with fallback to English |
hasLanguage | fun hasLanguage(languageCode: String): Boolean | Check if a language is supported |
toString | open override fun toString(): String | Debug info |
TextPlaceholderSDKSerializer
object
object TextPlaceholderSDKSerializer : KSerializer<TextPlaceholderSDK>Member | Declaration | Description |
|---|---|---|
descriptor | open override val descriptor: SerialDescriptor | |
deserialize | open override fun deserialize(decoder: Decoder): TextPlaceholderSDK | |
serialize | open override fun serialize(encoder: Encoder, value: TextPlaceholderSDK) | |
TextResourcesSDK
data class
@Serializable
data class TextResourcesSDK(val placeholder: TextPlaceholderSDK? = null, val changeLanguageButton: TextPlaceholderSDK? = null, val startOverButton: TextPlaceholderSDK? = null, val downloadButton: TextPlaceholderSDK? = null, val downloadFormatText: TextPlaceholderSDK? = null, val deleteButton: TextPlaceholderSDK? = null, val deleteText: TextPlaceholderSDK? = null, val changeLanguageText: TextPlaceholderSDK? = null, val cancelChatText: TextPlaceholderSDK? = null, val cancelChatButton: TextPlaceholderSDK? = null, val confirmActionButton: TextPlaceholderSDK? = null, val chatSettings: TextPlaceholderSDK? = null, val settingsButton: TextPlaceholderSDK? = null, val cancelButton: TextPlaceholderSDK? = null, val handoverQueueText: TextPlaceholderSDK? = null, val handoverQueueLink: TextPlaceholderSDK? = null, val takeoverQueueText: TextPlaceholderSDK? = null, val takeoverQueueLink: TextPlaceholderSDK? = null, val leaveQueueText: TextPlaceholderSDK? = null, val leaveQueueLink: TextPlaceholderSDK? = null, val chattingWithAgentText: TextPlaceholderSDK? = null, val userEndHandoverButtonText: TextPlaceholderSDK? = null, val userEndHandoverModalTitleText: TextPlaceholderSDK? = null, val userEndHandoverModalDescriptionText: TextPlaceholderSDK? = null, val agentJoinedText: TextPlaceholderSDK? = null, val agentLeftText: TextPlaceholderSDK? = null, val queuePositionText: TextPlaceholderSDK? = null, val estimatedTimeText: TextPlaceholderSDK? = null, val uploadFileSubtext: TextPlaceholderSDK? = null, val photoSelectorButton: TextPlaceholderSDK? = null, val fileSelectorButton: TextPlaceholderSDK? = null, val readMoreText: TextPlaceholderSDK? = null, val referenceListTitle: TextPlaceholderSDK? = null, val uploadFileFailed: TextPlaceholderSDK? = null)The legacy text block.
Every field is omittable, and the block itself is optional on SettingsResponse. Web has read the newer locales table only since 2026-09-11, so this block is dead weight on the server and the backend team expects to deprecate it — either all at once or a key at a time. Without defaults, kotlinx throws MissingFieldException and the whole settings payload fails to decode, so the chat would never load. Pinned by SettingsDecodingResilienceTest.
Member | Declaration | Description |
|---|---|---|
TextResourcesSDK | constructor(placeholder: TextPlaceholderSDK? = null, changeLanguageButton: TextPlaceholderSDK? = null, startOverButton: TextPlaceholderSDK? = null, downloadButton: TextPlaceholderSDK? = null, downloadFormatText: TextPlaceholderSDK? = null, deleteButton: TextPlaceholderSDK? = null, deleteText: TextPlaceholderSDK? = null, changeLanguageText: TextPlaceholderSDK? = null, cancelChatText: TextPlaceholderSDK? = null, cancelChatButton: TextPlaceholderSDK? = null, confirmActionButton: TextPlaceholderSDK? = null, chatSettings: TextPlaceholderSDK? = null, settingsButton: TextPlaceholderSDK? = null, cancelButton: TextPlaceholderSDK? = null, handoverQueueText: TextPlaceholderSDK? = null, handoverQueueLink: TextPlaceholderSDK? = null, takeoverQueueText: TextPlaceholderSDK? = null, takeoverQueueLink: TextPlaceholderSDK? = null, leaveQueueText: TextPlaceholderSDK? = null, leaveQueueLink: TextPlaceholderSDK? = null, chattingWithAgentText: TextPlaceholderSDK? = null, userEndHandoverButtonText: TextPlaceholderSDK? = null, userEndHandoverModalTitleText: TextPlaceholderSDK? = null, userEndHandoverModalDescriptionText: TextPlaceholderSDK? = null, agentJoinedText: TextPlaceholderSDK? = null, agentLeftText: TextPlaceholderSDK? = null, queuePositionText: TextPlaceholderSDK? = null, estimatedTimeText: TextPlaceholderSDK? = null, uploadFileSubtext: TextPlaceholderSDK? = null, photoSelectorButton: TextPlaceholderSDK? = null, fileSelectorButton: TextPlaceholderSDK? = null, readMoreText: TextPlaceholderSDK? = null, referenceListTitle: TextPlaceholderSDK? = null, uploadFileFailed: TextPlaceholderSDK? = null) | |
agentJoinedText | @SerialName(value = "agent_joined_text") val agentJoinedText: TextPlaceholderSDK? | |
agentLeftText | @SerialName(value = "agent_left_text") val agentLeftText: TextPlaceholderSDK? | |
cancelButton | @SerialName(value = "cancel_button") val cancelButton: TextPlaceholderSDK? | |
cancelChatButton | @SerialName(value = "cancel_chat_button") val cancelChatButton: TextPlaceholderSDK? | |
cancelChatText | @SerialName(value = "cancel_chat_text") val cancelChatText: TextPlaceholderSDK? | |
changeLanguageButton | @SerialName(value = "change_language_button") val changeLanguageButton: TextPlaceholderSDK? | |
changeLanguageText | @SerialName(value = "change_language_text") val changeLanguageText: TextPlaceholderSDK? | |
chatSettings | @SerialName(value = "chat_settings_text") val chatSettings: TextPlaceholderSDK? | |
chattingWithAgentText | @SerialName(value = "chatting_with_agent_text") val chattingWithAgentText: TextPlaceholderSDK? | |
confirmActionButton | @SerialName(value = "confirm_action_button") val confirmActionButton: TextPlaceholderSDK? | |
deleteButton | @SerialName(value = "delete_button") val deleteButton: TextPlaceholderSDK? | |
deleteText | @SerialName(value = "delete_text") val deleteText: TextPlaceholderSDK? | |
downloadButton | @SerialName(value = "download_button") val downloadButton: TextPlaceholderSDK? | |
downloadFormatText | @SerialName(value = "download_format_text") val downloadFormatText: TextPlaceholderSDK? | |
estimatedTimeText | @SerialName(value = "estimated_time_text") val estimatedTimeText: TextPlaceholderSDK? | |
fileSelectorButton | @SerialName(value = "ios_file_selector_button") val fileSelectorButton: TextPlaceholderSDK? | |
handoverQueueLink | @SerialName(value = "handover_queue_link") val handoverQueueLink: TextPlaceholderSDK? | |
handoverQueueText | @SerialName(value = "handover_queue_text") val handoverQueueText: TextPlaceholderSDK? | |
leaveQueueLink | @SerialName(value = "leave_queue_link") val leaveQueueLink: TextPlaceholderSDK? | |
leaveQueueText | @SerialName(value = "leave_queue_text") val leaveQueueText: TextPlaceholderSDK? | |
photoSelectorButton | @SerialName(value = "ios_photo_selector_button") val photoSelectorButton: TextPlaceholderSDK? | |
placeholder | @SerialName(value = "placeholder") val placeholder: TextPlaceholderSDK? | |
queuePositionText | @SerialName(value = "queue_position_text") val queuePositionText: TextPlaceholderSDK? | |
readMoreText | @SerialName(value = "read_more_text") val readMoreText: TextPlaceholderSDK? | |
referenceListTitle | @SerialName(value = "reference_list_title") val referenceListTitle: TextPlaceholderSDK? | |
settingsButton | @SerialName(value = "settings_button") val settingsButton: TextPlaceholderSDK? | |
startOverButton | @SerialName(value = "start_over_button") val startOverButton: TextPlaceholderSDK? | |
takeoverQueueLink | @SerialName(value = "takeover_queue_link") val takeoverQueueLink: TextPlaceholderSDK? | |
takeoverQueueText | @SerialName(value = "takeover_queue_text") val takeoverQueueText: TextPlaceholderSDK? | |
uploadFileFailed | @SerialName(value = "upload_file_failed") val uploadFileFailed: TextPlaceholderSDK? | |
uploadFileSubtext | @SerialName(value = "upload_file_subtext") val uploadFileSubtext: TextPlaceholderSDK? | |
userEndHandoverButtonText | @SerialName(value = "user_end_handover_button_text") val userEndHandoverButtonText: TextPlaceholderSDK? | |
userEndHandoverModalDescriptionText | @SerialName(value = "user_end_handover_modal_description_text") val userEndHandoverModalDescriptionText: TextPlaceholderSDK? | |
userEndHandoverModalTitleText | @SerialName(value = "user_end_handover_modal_title_text") val userEndHandoverModalTitleText: TextPlaceholderSDK? | |
TriggerTypeSDK
enum
@Serializable
enum TriggerTypeSDK : Enum<TriggerTypeSDK>Member | Declaration | Description |
|---|---|---|
BOT_CONVERSATION | @SerialName(value = "bot_conversation") BOT_CONVERSATION | |
HANDOVER_CONVERSATION | @SerialName(value = "handover_conversation") HANDOVER_CONVERSATION | |
entries | val entries: EnumEntries<TriggerTypeSDK> | Returns a representation of an immutable list of all enum entries, in the order they're declared. This method may be used to iterate over the enum entries. |
valueOf | fun valueOf(value: String): TriggerTypeSDK | Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Throws - kotlin.IllegalArgumentException: if this enum type has no constant with the specified name |
values | fun values(): Array<TriggerTypeSDK> | Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. |
TriggerTypeSDK.Companion
object
object CompanionMember | Declaration | Description |
|---|---|---|
fromString | fun fromString(value: String): TriggerTypeSDK? | |