UIConfiguration

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(), agentConfiguration: AgentConfiguration = AgentConfiguration(), conversationOptionsConfiguration: ConversationOptionsConfiguration = ConversationOptionsConfiguration(), multimediaExtension: MultimediaCoreExtension? = null, clientType: ClientType = ClientType.MIAW_MOBILE_V1, clientName: ClientName = ClientName.MOBILE_IN_APP_SDK)


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(), agentConfiguration: AgentConfiguration = AgentConfiguration(), conversationOptionsConfiguration: ConversationOptionsConfiguration = ConversationOptionsConfiguration(), multimediaExtension: MultimediaCoreExtension? = null)

Creates a UIConfiguration from explicit string parameters.

Use this constructor when you have the deployment values as strings rather than a pre-built Configuration object. The serviceAPI string is converted to a URL internally.

Parameters

serviceAPI

The service API endpoint as a string (e.g., "https://myorg.my.salesforce-scrt.com").

organizationId

The 18-character Salesforce organization ID.

developerName

The API Name of the Embedded Service Deployment.

conversationId

A unique identifier for the conversation.

createConversationOnSubmit

When true (default), the conversation is created on pre-chat submit.

isAuthenticated

Set to true if the deployment requires user verification.

urlDisplayMode

Controls how tappable URLs are opened. Defaults to UrlDisplayMode.InlineBrowser.

remoteLocaleMap

Locale-to-language mapping for custom label resolution.

attachmentConfiguration

Controls file attachment permissions and constraints.

transcriptConfiguration

Controls transcript download availability.

agentConfiguration

Controls agent display behavior.

conversationOptionsConfiguration

Controls conversation menu options.

multimediaExtension

Optional extension enabling voice and video capabilities.

See also

Throws

Samples

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

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

Creates a UIConfiguration from an existing Configuration instance.

This is the recommended constructor when using CoreConfiguration.fromFile to load deployment settings. Connection details (service URL, org ID, developer name, locale map, and user verification setting) are inherited from the provided configuration.

Parameters

configuration

A Configuration supplying deployment connection details. Typically obtained via CoreConfiguration.fromFile.

conversationId

A unique identifier for the conversation.

createConversationOnSubmit

When true (default), the conversation is created on pre-chat submit.

urlDisplayMode

Controls how tappable URLs are opened. Defaults to UrlDisplayMode.InlineBrowser.

attachmentConfiguration

Controls file attachment permissions and constraints.

transcriptConfiguration

Controls transcript download availability.

agentConfiguration

Controls agent display behavior.

conversationOptionsConfiguration

Controls conversation menu options.

See also