ui/com.salesforce.android.smi.ui/UIClient

UIClient

interface UIClient

The entry point for the Messaging for In-App UI SDK.

UIClient provides the primary interface for launching and configuring the pre-built messaging UI. It manages the lifecycle of the conversation view and bridges between the UI layer and the underlying CoreClient business logic.

Obtain an instance using UIClient.Factory:

See also

UIConfiguration

UIClientFactory

Samples

val configuration = UIConfiguration(
    serviceAPI = "https://myorg.my.salesforce-scrt.com",
    organizationId = "00D000000000001AAA",
    developerName = "My_Deployment",
    conversationId = UUID.randomUUID()
)
val uiClient = UIClient.Factory.create(configuration)

Types

object Companion

Factory for creating, retrieving, and destroying UIClient instances.

Properties

abstract val configuration: UIConfiguration

The UIConfiguration that this instance was created with.

preChatFieldValueProvider

abstract var preChatFieldValueProvider: (List<PreChatField>) -> List<PreChatField>?

A provider for pre-populating visible pre-chat field values before the form is displayed.

abstract var viewComponents: ViewComponents

A container for customizing the Composable components rendered in the messaging UI.

Functions

conversationClient

abstract fun conversationClient(context: Context): ConversationClient

Returns a ConversationClient bound to the UIConfiguration.conversationId.

abstract fun coreClient(context: Context): CoreClient

Returns the CoreClient instance associated with this UI client.

createOpenConversationIntent

abstract fun createOpenConversationIntent(context: Context): Intent

Creates an Intent for launching the messaging UI activity.

MessagingInAppUI

open fun MessagingInAppUI(onExit: () -> Unit)

A Composable that renders the full messaging UI for this client instance.

openConversationActivity

abstract fun openConversationActivity(context: Context)

Launches the messaging UI in a new full-screen activity.