core/com.salesforce.android.smi.core/CoreConfiguration

CoreConfiguration

@JsonClass(generateAdapter = true)

data class CoreConfiguration(@Json(name = "Url") val serviceAPI: URL, @Json(name = "OrganizationId") val organizationId: String, @Json(name = "DeveloperName") val developerName: String, val isUserVerificationRequired: Boolean = false, val remoteLocaleMap: Map<String, String> = emptyMap(), val multimediaExtension: MultimediaCoreExtension? = null, val clientType: ClientType = ClientType.MIAW_MOBILE_V1, val clientName: ClientName = ClientName.MOBILE_IN_APP_SDK) : Configuration

The default Configuration implementation used to create a CoreClient instance.

Create a CoreConfiguration using one of the following approaches:

From a config file (recommended) -- download the JSON config file from your Salesforce Embedded Service Deployment (Setup > Embedded Service Deployments > Get Code File) and place it in your app's assets/ directory:

Parameters

serviceAPI

The service API endpoint URL from the config file (Url field).

organizationId

The Salesforce organization ID (OrganizationId field).

developerName

The API Name of the Embedded Service Deployment (DeveloperName field).

isUserVerificationRequired

Set to true if the deployment requires user verification.

remoteLocaleMap

Locale-to-language mapping for custom label resolution. See Configuration.remoteLocaleMap.

multimediaExtension

Optional extension enabling voice and video capabilities.

clientType

The client protocol version. Defaults to ClientType.MIAW_MOBILE_V1.

clientName

The SDK product name. Defaults to ClientName.MOBILE_IN_APP_SDK.

Samples

val configuration = CoreConfiguration.fromFile(
    context,
    remoteLocaleMap = mapOf("en-CA" to "en", "fr-FR" to "fr", "default" to "en")
)

val configuration = CoreConfiguration(
    serviceAPI = URL("https://myorg.my.salesforce-scrt.com"),
    organizationId = "00D000000000001",
    developerName = "My_Messaging_Deployment"
)

Constructors

CoreConfiguration

constructor(@Json(name = "Url") serviceAPI: URL, @Json(name = "OrganizationId") organizationId: String, @Json(name = "DeveloperName") developerName: String, isUserVerificationRequired: Boolean = false, remoteLocaleMap: Map<String, String> = emptyMap(), multimediaExtension: MultimediaCoreExtension? = null, clientType: ClientType = ClientType.MIAW_MOBILE_V1, clientName: ClientName = ClientName.MOBILE_IN_APP_SDK)

constructor(serviceAPI: String, organizationId: String, developerName: String, isUserVerificationRequired: Boolean = false, remoteLocaleMap: Map<String, String> = emptyMap(), multimediaExtension: MultimediaCoreExtension? = null, clientType: ClientType = ClientType.MIAW_MOBILE_V1, clientName: ClientName = ClientName.MOBILE_IN_APP_SDK)

Creates a configuration from string parameters.

constructor(configuration: Configuration)

Creates a CoreConfiguration by copying values from an existing Configuration instance.