MarketingCloudConfig
Package: com.salesforce.marketingcloud
Type: data class
Extends: EngagementModuleConfig
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.
| 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 |
| 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.
Builder pattern implementation for constructing MarketingCloudConfig instances.
Companion object for static utility methods and constants.
Converts the current configuration instance back into a Builder for modification.
Returns: A new Builder instance populated with current configuration values
This configuration class is typically instantiated using the Builder pattern:
The configuration object is then passed to the Marketing Cloud SDK during initialization.