EntryPoint

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, state

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.

Initiates a handover to a human agent. The listener is called when the handover is ready.

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

Clears any previously set context.

Clears any pending trigger dialogue request.

Dismisses the chat UI without ending the session.

Displays the chat UI directly. NOTE: This method is kept for backward compatibility. It's recommended to use launchChat() instead which ensures proper connection before displaying the UI.

Ends the active chat session, clears messages and token, and dismisses the UI.

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

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

Returns true if the given push notification originated from the Kindly service.

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. This method handles both the connection to the Kindly service and displaying the UI. It's the recommended way to launch the chat experience.

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.

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

Sets context key-value pairs that will be attached to the next message or button click request.

Initializes the Kindly Chat SDK. This is the first method that should be called before using any other SDK functions. The SDK will automatically use NATIVE behavior for optimal performance and compliance.

Triggers a specific dialogue by its ID. The SDK must be connected.