Companion

The SDK configuration for permissions and theme settings.

Whether the SDK should send crash reports via Sentry. Defaults to true.

Unified event flow for all Kindly events (matches web API pattern) Subscribe to this to receive all events: load, message, buttonClick, ui, globalIcon, state

Flow that emits input field visibility changes Subscribe to this to get real-time updates when input field should be hidden or shown

Optional delegate for receiving button press and link interception callbacks.

Unified state flow that emits state change events Subscribe to this to get real-time updates of: isChatDisplayed, isConnected, isStarted, isSocketConnected

Whether verbose logging is enabled. Defaults to false.

Clear any previously set settings overrides.

Override parts of the settings response for testing purposes. Pass a map following the same JSON hierarchy as the settings response. The overrides are deep-merged with the server response — only the keys you provide are replaced.

Force the logger into "show everything" mode at runtime, surfacing every log level (including VERBOSE) on production builds. Equivalent to building with WHERE_AM_I = LOCAL, but scoped to logging only — does not affect API endpoints, Pusher key, Sentry, or anything else that reads Session.whereAmI.

Handovers the call from the chatBot.

Clears any custom theme that has been set and reverts to the default theme.

Clears the current context of the chat.

Clearing trigger dialog param call

Closes the chat.

Displays the chat UI. This method is kept for backward compatibility but it's recommended to use launchChat() instead which handles connection logic.

Ends the chat session and disconnects from the server. This acts as a disconnect - the SDK remains initialized and can be reconnected by calling launchChat() again without needing to call start(). Use kill() if you want to completely terminate the SDK.

Handles an incoming Firebase push notification. Call this from your FirebaseMessagingService.

Handles a Kindly URL scheme deep link. Supported format: kindly://chat/dialogue/{id}

Gets the current input field visibility state.

Checks if a notification is from Kindly.

Completely kills the SDK and clears all state. After calling this method, start() must be called again before using any other SDK functions. This is more destructive than endChat() which only disconnects the chat session.

Opens the chat bot after connecting to the Kindly service.

Saves the Firebase Cloud Messaging token for push notifications.

Send a message on behalf of the user, programmatically.

Sets a custom theme for the chat UI.

Sets a custom theme using individual color parameters. Only specified colors (non-null) will override the default theme.

Manually controls input field visibility. This will override any automatic visibility settings from messages or global settings.

Updates the language for the current SDK session. This will be used for all subsequent chat connections and UI elements.

Sets a new context for the chat.

Initializes the chat SDK with the provided application, chatBotKey, and codeLanguage. The SDK will automatically use NATIVE behavior for optimal performance and compliance.

Triggers a dialog for the provided id.