MarketingCloudConfig

Package: com.salesforce.marketingcloud

Type: data class

Extends: EngagementModuleConfig

Overview

The MarketingCloudConfig class is a data configuration class for the Salesforce Marketing Cloud Unified SDK. It contains all configuration parameters needed to initialize and customize the Marketing Cloud SDK functionality.

Class Declaration

1data class MarketingCloudConfig : EngagementModuleConfig

Properties

Required Configuration

Property	Type	Description
`accessToken`	`String`	Authentication token for Marketing Cloud API access
`applicationId`	`String`	Unique identifier for the application
`marketingCloudServerUrl`	`String`	The Marketing Cloud server URL endpoint

Optional Configuration

Property	Type	Description
`mid`	`String?`	Marketing Cloud Member ID (nullable)
`analyticsEnabled`	`Boolean`	Enables or disables analytics tracking
`piAnalyticsEnabled`	`Boolean`	Enables or disables Predictive Intelligence analytics
`inboxEnabled`	`Boolean`	Enables or disables inbox messaging functionality
`geofencingEnabled`	`Boolean`	Enables or disables geofencing features
`proximityEnabled`	`Boolean`	Enables or disables proximity/beacon messaging
`delayRegistrationUntilContactKeyIsSet`	`Boolean`	Delays device registration until contact key is provided
`markMessageReadOnInboxNotificationOpen`	`Boolean`	Auto-marks inbox messages as read when notification is opened
`useLegacyPiIdentifier`	`Boolean`	Uses legacy identifier format for Predictive Intelligence
`urlHandler`	`UrlHandler?`	Custom handler for URL processing (nullable)
`proximityNotificationCustomizationOptions`	`ProximityNotificationCustomizationOptions?`	Customization options for proximity notifications (nullable)

All properties are annotated with @JvmField for Java interoperability.

Nested Types

Builder

1class Builder

Builder pattern implementation for constructing MarketingCloudConfig instances.

Companion

1object Companion

Companion object for static utility methods and constants.

Methods

toBuilder()

1fun toBuilder(): MarketingCloudConfig.Builder

Converts the current configuration instance back into a Builder for modification.

Returns: A new Builder instance populated with current configuration values

Usage

This configuration class is typically instantiated using the Builder pattern:

1val config = MarketingCloudConfig.Builder()
2    .setAccessToken("your-access-token")
3    .setApplicationId("your-app-id")
4    .setMarketingCloudServerUrl("https://your-server.com")
5    .setAnalyticsEnabled(true)
6    .build()

The configuration object is then passed to the Marketing Cloud SDK during initialization.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!