Configuration

interface Configuration

Defines the parameters required to connect to a Salesforce Messaging for In-App deployment.

A Configuration supplies the endpoint, org identity, and deployment name that the SDK uses to authenticate and communicate with the messaging service. Obtain these values from the Embedded Service Deployment settings in your Salesforce org (Setup > Embedded Service Deployments).

The simplest way to create a configuration is by using CoreConfiguration.fromFile with the JSON config file downloaded from your deployment:

See also

Samples

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

Inheritors

Properties

Link copied to clipboard

Identifies the SDK product variant sent on authorization requests. Use the default unless directed otherwise by Salesforce support.

Link copied to clipboard

Identifies the client protocol version sent on authorization requests. Use the default unless directed otherwise by Salesforce support.

Link copied to clipboard
abstract val developerName: String

The API Name of the Embedded Service Deployment. This is the DeveloperName field in the downloaded config file.

Link copied to clipboard

When true, indicates that this deployment requires user verification via a signed JWT. The SDK will invoke the registered UserVerificationProvider to obtain tokens before authorizing requests.

Link copied to clipboard

An optional MultimediaCoreExtension that enables voice and video capabilities. Pass null (default) if multimedia is not needed.

Link copied to clipboard
abstract val organizationId: String

The 18-character Salesforce organization ID. This is the OrganizationId field in the downloaded config file.

Link copied to clipboard

Maps device locale codes to deployment-configured languages for resolving custom label translations. Both keys and values are case-insensitive. The special key "default" provides a fallback when no locale match is found.

Link copied to clipboard
abstract val serviceAPI: URL

The base URL of the Messaging for In-App service API for your org. This is the Url field in the downloaded config file.