UIConfiguration

data class UIConfiguration(val serviceAPI: URL, val organizationId: String, val developerName: String, val conversationId: UUID, val createConversationOnSubmit: Boolean = true, val isUserVerificationRequired: Boolean = true) : 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.

Constructors

Link copied to clipboard
constructor(serviceAPI: String, organizationId: String, developerName: String, conversationId: UUID, createConversationOnSubmit: Boolean, isAuthenticated: Boolean)

Creates a configuration object used to create an UIClient instance.

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

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)

Properties

Link copied to clipboard
val conversationId: UUID
Link copied to clipboard
val createConversationOnSubmit: Boolean = true
Link copied to clipboard
open override val developerName: String
Link copied to clipboard
open override val isUserVerificationRequired: Boolean = true
Link copied to clipboard
open override val organizationId: String
Link copied to clipboard
open override val serviceAPI: URL

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)