MarketingCloudSDK iOS (v8.1.3)

• Home
• Documentation
• AppleDoc
• MobilePush
• Get Started
• Overview
• 1. Provision for Push
• 2. Setup MobilePush Apps
• 3. Add the SDK
• 4. Configure the SDK
• 5. Enable Push
• 6. Migrating to 8.x
• Testing the SDK
• Development / Xcode
• Production / Distribution
• SDK Implementation
• Data Protection and Privacy
• Device and Contact Registration
• Handle URLs
• Runtime Toggles
• Push Notifications
• Customize Push Notifications
• Custom Sound
• Interactive Notifications
• Rich Notifications
• OpenDirect
• Custom Keys
• Application Badging
• Application Badge Override
• Event Tracking
• Mobile App Event Tracking
• In-App Messaging
• In-App Messaging
• Inbox Messaging
• Inbox Messaging
• Location Messaging
• Geofence and Beacon Messaging
• Background Location Updates
• Location Message Segmentation
• Analytics
• Analytics
• Einstein Recommendations and Collect API Integration
• Use Cases
• MobilePush SDK Privacy Manifest
• MobilePush SDK Use Cases
• Troubleshooting
• App Submission
• Push Setup
• Multiple Push SDKs
• iOS Data Protection
• Data Merge
• Keychain Crash
• MarketingCloudSDK.bundle inclusion Crash

The Runtime Toggle feature, also known as “feature toggles”, allows you to dynamically enable or disable specific functionalities within the SDK without the need to re-initialize it. With Runtime Toggles, you have control over the following features:

1. Analytics: Enables or disables Salesforce MarketingCloud Analytics services.
2. PI (Predictive Intelligence) Analytics: Enables or disables Salesforce Predictive Intelligence Analytics services.
3. Inbox: Enables or disables Inbox messaging services.
4. Location: Enables or disables location-based push notification and messaging services.

By utilizing the Runtime Toggles feature, you can fine-tune your application’s behavior, adapt to changing requirements, and ensure compliance with GDPR regulations effortlessly.

API Usage

To interact with the Runtime Toggles, the SDK provides APIs for each feature to set and get status of toggled feature.

Toggle APIs

SFMCSdk.requestPushSdk { mp in
    mp.setAnalyticsEnabled(_: Bool)
    mp.isAnalyticsEnabled()
}

For more details see the Feature Toggle Apple Documentation.

The setAnalyticsEnabled function allows you to enable or disable the Analytics feature. By passing true, Analytics services will be enabled, while passing false will disable them. The isAnalyticsEnabled function returns the current status of the Analytics toggle.

Note: The remaining feature toggle APIs follow a similar pattern.

Explaining Analytic Runtime Toggle

The functionality of analytic runtime toggles entails several actions when disabling it. Firstly, it involves the removal of all non-billable analytics, and secondly, it ensures that the SDK does not record any non-billable analytics.

Non-billable analytics encompass data that appears in reports and relates to how marketers monitor the performance of their messaging. For example, tracking of push notifications and inbox opens. See Analytics documentation for more details on this. On the other hand, billable analytics serve the purpose of informing Marketing Cloud whether a billable action occurred, without tracking any user-specific information. Therefore, although certain “analytics” will still be transmitted to Marketing Cloud when the toggle is disabled, they exclusively pertain to billable events and do not involve any user-related data from the device.