messaging-inapp-ui/com.salesforce.android.smi.ui/UIConfiguration

UIConfiguration

data class UIConfiguration(val serviceAPI: URL, val organizationId: String, val developerName: String, val conversationId: UUID, val createConversationOnSubmit: Boolean = true, val isUserVerificationRequired: Boolean = true, val urlDisplayMode: UrlDisplayMode = UrlDisplayMode.InlineBrowser, val remoteLocaleMap: Map<String, String> = emptyMap(), val attachmentConfiguration: AttachmentConfiguration = AttachmentConfiguration(), val transcriptConfiguration: TranscriptConfiguration = TranscriptConfiguration()) : Configuration

Configuration used to create an UIClient instance.

Parameters

serviceAPI

The service API endpoint URL.

organizationId

Your Salesforce org ID.

developerName

The API Name for the embedded service deployment associated with this configuration.

conversationId

The conversationID to open.

createConversationOnSubmit

A flag to specify whether a conversation should be created when pre-chat is submitted. Defaults to true.

isUserVerificationRequired

Denotes the deployment as being configured for authenticated users.

urlDisplayMode

An enum to specify how URLs should be opened by default on the end user's device.

remoteLocaleMap

The localization map used for resolving the language for custom labels returned when requesting a RemoteConfiguration.

attachmentConfiguration

Configuration object for Attachments.

transcriptConfiguration

Configuration object for Transcripts.

Constructors

UIConfiguration

constructor(serviceAPI: String, organizationId: String, developerName: String, conversationId: UUID, createConversationOnSubmit: Boolean = true, isAuthenticated: Boolean = true, urlDisplayMode: UrlDisplayMode = UrlDisplayMode.InlineBrowser, remoteLocaleMap: Map<String, String> = emptyMap(), attachmentConfiguration: AttachmentConfiguration = AttachmentConfiguration(), transcriptConfiguration: TranscriptConfiguration = TranscriptConfiguration())

Creates a configuration object used to create an UIClient instance.

constructor(configuration: Configuration, conversationId: UUID, createConversationOnSubmit: Boolean = true, urlDisplayMode: UrlDisplayMode = UrlDisplayMode.InlineBrowser, attachmentConfiguration: AttachmentConfiguration = AttachmentConfiguration(), transcriptConfiguration: TranscriptConfiguration = TranscriptConfiguration())

Creates a configuration object used to create an UIClient instance.

constructor(serviceAPI: URL, organizationId: String, developerName: String, conversationId: UUID, createConversationOnSubmit: Boolean = true, isUserVerificationRequired: Boolean = true, urlDisplayMode: UrlDisplayMode = UrlDisplayMode.InlineBrowser, remoteLocaleMap: Map<String, String> = emptyMap(), attachmentConfiguration: AttachmentConfiguration = AttachmentConfiguration(), transcriptConfiguration: TranscriptConfiguration = TranscriptConfiguration())