UIConfiguration

constructor(serviceAPI: String, organizationId: String, developerName: String, conversationId: UUID, createConversationOnSubmit: Boolean, isAuthenticated: Boolean)

Creates a configuration object 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.

isAuthenticated

Denotes the deployment as being configured for authenticated users.


constructor(configuration: Configuration, conversationId: UUID, createConversationOnSubmit: Boolean = true)

Creates a configuration object used to create an UIClient instance.

Parameters

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.


constructor(serviceAPI: URL, organizationId: String, developerName: String, conversationId: UUID, createConversationOnSubmit: Boolean = true, isUserVerificationRequired: Boolean = true)

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.