Salesforce Engagement SDK (marketing-cloud-mobilepush)
- Get Started with the Salesforce Engagement SDK
- How the Engagement SDK Works
- Prerequisites
- Developer Resources
- Common Terminology
- Use the SDK with Marketing Cloud Engagement
- Analytics
- Enable and Use Analytics on Android
- Integrate Einstein Recommendations and Collect API
- Track Cart
- Track Conversion
- Track Inbox Message Opens
- Track Page Views
- Send Custom Campaign Details to Google Analytics 4
- Enable and Use Analytics on iOS
- Track Inbox Message Opens
- Track Push Notifications
- Integrate Einstein Recommendations and Collect API
- Track Cart
- Track Conversion
- Track Page Views
- Change Log
- Data Protection and Privacy
- Development Frameworks
- Cordova Plugin
- Configure the Cordova Plugin for Android Apps
- Configure the Cordova Plugin for Android Apps
- Cordova Plugin API Reference
- Flutter Plugin
- Configure the Flutter Plugin for Android Apps
- Configure the Flutter Plugin for iOS Apps
- Flutter Plugin API Reference
- Integrate the Cordova Plugin with Capacitor or Ionic Apps
- React Native Plugin
- Configure the React Native Plugin for Android Apps
- Configure the React Native Plugin for iOS Apps
- React Native Plugin API Reference
- Event Tracking
- Handle URLs in Messages
- In-App Messages
- Implement In-App Messaging on Android
- Required Methods for Button Actions
- Customize Fonts for In-App Messages on Android
- Listen for Events
- Prevent or Delay Message Display
- Set Status Bar Color
- Track Message View States
- Implement In-App Messaging on iOS
- Configure Push Permission Authorization for In-App Messages on iOS
- Customize Fonts for In-App Messages on iOS
- Prevent or Delay Message Display
- Set an Event Delegate
- Track Message View States
- Inbox Messages
- Implement Inbox Messaging on Android
- Alert + Inbox Messages
- Public Properties
- Implement Inbox Messaging on iOS
- Alert + Inbox Messages
- Public Properties
- Integrate the MobilePush Android SDK
- Initialize the SDK
- Implement the SDK with CocoaPods
- iOS Data Protection
- Implement the SDK Manually
- Apple Privacy Manifest
- Privacy Manifest Support for Hybrid Plugins
- Privacy Manifest Support for Older iOS SDK Versions
- Implement the SDK with Swift Package Manager
- Integrate the SDK for iOS
- Configure the SDK for iOS
- Integrate the Salesforce Engagement SDK Extension for iOS
- Configure the Content Extension for the iOS Extension SDK
- Configure the Service Extension for the iOS Extension SDK
- Enable App Groups Capability
- Handle Carousel Click Actions
- Location Messages
- Implement Location Messaging on Android
- Add Beacons
- Enable Beacon Debug Logging
- Add Geofences
- Implement Location Messaging on iOS
- Enable Background Location Updates
- Enable Beacon Support
- Segment Location Messages
- Configure Marketing Cloud Engagement
- Push Notifications
- Push Notifications for Android
- Configure Button and Carousel Actions for Android Push Notifications
- Implement Default and Custom Notification Channels for the Android SDK
- Customize Push Notification Functionality for Android Apps
- Customize Push Notifications for Android
- Advanced Push Notification Customization for the Android SDK
- Request Runtime Notification Permission on Android
- Configure Push Delivery Analytics for Android
- Notification Segmentation
- Push Notifications for iOS
- Handle Custom Keys Sent with Message Payload
- Customize Push Notification Functionality for iOS Apps
- Enable Push Notifications on iOS
- Display Interactive Notifications
- Messages with an OpenDirect URL
- Push Delivery Analytics
- Send Rich Notifications
- Specify a Custom Notification Sound
- Handle URLs in the SDK for iOS
- Register Contacts and Devices
- Set or Clear Attributes
- Set Contact Attributes and Tags
- Check Required Registration Fields
- Contact Dissociation
- Delay Registrations Until Contact Key is Set on Android
- Delay Registrations Until Contact Key is Set on iOS
- Determine Your Contact Key Strategy
- Set the Contact Key
- Manage Tags
- Runtime Toggles
- Troubleshooting
- Troubleshoot Issues on Android Apps
- Troubleshoot Initialization Errors on Android
- Troubleshoot Multiple Push SDKs on Android
- Troubleshoot Push Delivery Analytics on Android
- Troubleshoot Push Messages Not Displayed on Android
- Apple Push Notification Service Server Configuration
- Troubleshoot Initialization and Registration
- Troubleshoot Issues on iOS Apps
- MarketingCloudSDK.bundle Inclusion Crash
- Troubleshoot Data Merge
- iOS Data Protection
- Troubleshoot Issues in iOS Service Extensions
- Keychain Crash
- Troubleshoot Multiple Push SDKs
- Troubleshoot Multiple Push SDKs with Swizzling Enabled
- Troubleshoot Multiple Push SDKs with Swizzling Disabled
- Troubleshoot Push Delivery Analytics
- Push Messages Not Displayed
- Check the Log Output
- Log SDK State Information
- Send a Test Push
- Unblock Network Ports
- Troubleshoot the "No Such Module 'SFMCSDK'" Error
- Silent Push Notification
- Troubleshoot iOS App Submission Errors
- Troubleshoot Your Push Implementation
- Upgrade the SDK
- Migrate Android Apps to Version 10 of the SDK
- Analytics in Android Apps that Use SDK Version 10
- Beacon Messaging in Android Apps that Use SDK Version 10
- Set Contact Attributes in Android Apps that use SDK Version 10
- Contact Dissociation in Android Apps that use SDK Version 10
- Set Contact Tags in Android Apps that Use SDK Version 10
- In-App Messaging in Android Apps that use SDK Version 10
- Inbox Messaging in Android Apps that Use SDK Version 10
- Location Messaging in Android Apps that Use SDK Version 10
- Register Contacts in Android Apps that use SDK Version 10
- Set Runtime Toggles in Android Apps that Use SDK Version 10
- Migrate Android Apps to Version 11 of the SDK
- In-App Messaging Android Apps that use SDK Version 11
- Update Imports in Android Apps that use SDK Version 11
- Migrate to Version 8 of MobilePush SDK for Android
- Upgrade MobilePush SDK for Android From Version 8.x to 8.2.x
- Upgrade to Version 9 of the SDK for Android
- Migrate iOS Apps to Version 10 of the SDK
- Analytics in iOS Apps that Use SDK Version 10
- Migrate iOS Apps to Version 10 of the SDK using CocoaPods
- Set Contact Attributes in iOS Apps that use SDK Version 10
- Contact Dissociation in iOS Apps that use SDK Version 10
- Set Contact Tags in iOS Apps that use SDK Version 10
- In-App Messaging in iOS Apps that use SDK Version 10
- Location Messaging in iOS Apps that use SDK Version 10
- Register Contacts in iOS Apps that use SDK Version 10
- Set Runtime Toggles in iOS Apps that use SDK Version 10
- Migrate iOS Apps to Version 11 of the SDK
- In-App Messaging in iOS Apps that use SDK Version 11
- Update Imports in iOS Apps that use SDK Version 11
- Migrate to Version 8 of MobilePush SDK for iOS
- Upgrade the SDK from Version 8 to Version 9
- Migrate from Version 9 to Version 10 of the SDK
- Migrate to Version 11 of the SDK
- Upgrade to Version 8 of the SDK
- Upgrade to Version 9 of the SDK
- Test and Validate Your Implementation
- Test and Validate Basic Push Implementation
- Test and Validate Registrations
- Use the SDK with Marketing Cloud Next
- Analytics
- Enable and Use Analytics on Android
- Event Tracking
- Enable and Use Analytics on iOS
- Change Log
- Integrate with Other Platforms
- Handle URLs in Messages
- In-App Messaging
- Implement In-App Messaging on Android
- Implement In-App Messaging on iOS
- Integrate the Mobile App Messaging SDK with your Android App
- Integrate the iOS SDK
- Add the SDK Dependencies by using CocoaPods
- Configure the SDK
- Add the SDK Dependencies Manually
- Add the SDK Dependencies by using Swift Package Manager
- Integrate the iOS Extension SDK
- Configure the Content Extension for the iOS Extension SDK
- Configure the Service Extension for the iOS Extension SDK
- Enable App Groups for the iOS Extension SDK for Marketing Cloud Next
- Configure Carousel Click Actions with the iOS Extension SDK
- Push Notifications in the Engagement SDK
- Push Notifications for Android
- Configure Button and Carousel Actions
- Implement Default and Custom Notification Channels
- Basic Push Notification Customization for Android
- Full Control Push Notification Customization for Android
- Enable Push Notifications
- Request Runtime Notification Permission on Android
- Push Notifications for iOS
- Enable Push Notifications for iOS
- Display Interactive Notifications
- Send Rich Notifications
- Specify a Custom Notification Sound for iOS Push Notifications
- Handle URLs
- User and Device Registration
- Set Individual Attributes
- Check Required Registration Fields
- Set the Party Identifier
- Runtime Toggles
- Configure Flutter for Android
- Configure Flutter for iOS
- Flutter Unified Plugin API Reference
- Install and configure
- Migration Checklist
- Unified Flutter Setup
- Migrate to Flutter Unified Plugin
- Migration Steps
- Hybrid Platform Support for Unified Mobile SDK
- React Native Unified Plugin API Reference
- Configure React Native for Android
- Configure React Native for iOS
- Install and Configure the Unified React Native Plugin
- Migrate to React Native Unified Plugin
- Migration Steps
- Migration Checklist
- Unified React Native Plugin
- Android SDK v11 Reference
- com.salesforce.marketingcloud
- UrlHandler
- com.salesforce.marketingcloud - Interfaces
- Common
- InAppMessagingFeatureConfig
- com.salesforce.marketingcloud.inappmessagingfeature.config - Classes
- com.salesforce.marketingcloud.inappmessagingfeature.config
- InAppMessageCloseAction
- InAppMessagingFeature
- InAppMessagingFeatureInitializationStatus
- com.salesforce.marketingcloud.inappmessagingfeature - Classes
- InAppMessageDismissReason
- com.salesforce.marketingcloud.inappmessagingfeature - Enums
- com.salesforce.marketingcloud.inappmessagingfeature
- InAppMessageManager
- WhenReadyListener
- com.salesforce.marketingcloud.inappmessagingfeature - Interfaces
- In App Messaging Feature Module
- InAppMessage
- com.salesforce.marketingcloud.inappmessaging.models - Classes
- com.salesforce.marketingcloud.inappmessaging.models
- In App Messaging Models Module
- com.salesforce.marketingcloud.analytics
- PiCart
- PiCartItem
- PiOrder
- com.salesforce.marketingcloud.analytics - Classes
- AnalyticsManager
- com.salesforce.marketingcloud.analytics - Interfaces
- LatLon
- com.salesforce.marketingcloud.location - Classes
- com.salesforce.marketingcloud.location
- GeofenceMessageResponse
- com.salesforce.marketingcloud.messages.geofence - Classes
- com.salesforce.marketingcloud.messages.geofence
- com.salesforce.marketingcloud.messages.inbox.InboxMessage.Media
- InboxMessage
- com.salesforce.marketingcloud.messages.inbox - Classes
- InboxMessageManager
- com.salesforce.marketingcloud.messages.inbox - Interfaces
- com.salesforce.marketingcloud.messages.inbox
- ProximityMessageResponse
- com.salesforce.marketingcloud.messages.proximity - Classes
- com.salesforce.marketingcloud.messages.proximity
- Message
- Region
- com.salesforce.marketingcloud.messages - Classes
- RegionMessageManager
- com.salesforce.marketingcloud.messages - Interfaces
- com.salesforce.marketingcloud.messages
- NotificationCustomizationOptions
- NotificationManager
- NotificationMessage
- ProximityNotificationCustomizer
- PushNotificationActionHandler
- com.salesforce.marketingcloud.notifications - Classes
- com.salesforce.marketingcloud.notifications
- BeaconLogger
- BeaconRegion
- ProximityNotificationCustomizationOptions
- com.salesforce.marketingcloud.proximity - Classes
- com.salesforce.marketingcloud.proximity
- Registration Class
- com.salesforce.marketingcloud.registration - Classes
- RegistrationManager
- com.salesforce.marketingcloud.registration - Interfaces
- com.salesforce.marketingcloud.registration
- com.salesforce.marketingcloud
- InitializationStatus
- MarketingCloudConfig
- MarketingCloudSdk
- com.salesforce.marketingcloud - Classes
- MCLogListener
- com.salesforce.marketingcloud - Interfaces
- Marketing Cloud SDK
- AnalyticsManager
- com.salesforce.marketingcloud.mobileappmessaging.analytics - Interfaces
- com.salesforce.marketingcloud.mobileappmessaging.analytics
- Registration
- com.salesforce.marketingcloud.mobileappmessaging.registration - Classes
- RegistrationManager
- com.salesforce.marketingcloud.mobileappmessaging.registration - Interfaces
- com.salesforce.marketingcloud.mobileappmessaging.registration
- MobileAppMessaging
- MobileAppMessagingConfig
- MobileAppMessagingInitializationStatus
- com.salesforce.marketingcloud.mobileappmessaging - Classes
- com.salesforce.marketingcloud.mobileappmessaging
- Mobile App Messaging SDK
- PushFeatureConfig
- com.salesforce.marketingcloud.pushfeature.config - Classes
- com.salesforce.marketingcloud.pushfeature.config
- NotificationCustomizationOptions
- NotificationManager
- com.salesforce.marketingcloud.pushfeature.notifications - Classes
- com.salesforce.marketingcloud.pushfeature.notifications
- IntentProvider
- PushMessageManager
- PushMessagingService
- com.salesforce.marketingcloud.pushfeature.push - Classes
- com.salesforce.marketingcloud.pushfeature.push
- PushFeature
- PushFeatureInitializationStatus
- WhenReadyHandler
- com.salesforce.marketingcloud.pushfeature - Classes
- InitializationListener
- WhenReadyListener
- com.salesforce.marketingcloud.pushfeature - Interfaces
- com.salesforce.marketingcloud.pushfeature
- Push Feature Module
- Action
- Media
- Text
- com.salesforce.marketingcloud.pushmodels.data - Classes
- Style
- Template
- com.salesforce.marketingcloud.pushmodels.data - Interfaces
- com.salesforce.marketingcloud.pushmodels.data
- BadMediaException
- InvalidCompressionException
- InvalidJsonException
- MissingFieldException
- PushException
- UnknownErrorException
- UnsupportedWidgetException
- com.salesforce.marketingcloud.pushmodels.exceptions - Classes
- ErrorCode
- com.salesforce.marketingcloud.pushmodels.exceptions - Enums
- com.salesforce.marketingcloud.pushmodels.exceptions
- LatLon
- com.salesforce.marketingcloud.pushmodels.location - Classes
- com.salesforce.marketingcloud.pushmodels.location
- RichButton
- RichButtonTemplate
- com.salesforce.marketingcloud.pushmodels.rich.buttons - Classes
- com.salesforce.marketingcloud.pushmodels.rich.buttons
- CarouselItem
- CarouselFullTemplate
- com.salesforce.marketingcloud.pushmodels.rich.carousel - Classes
- com.salesforce.marketingcloud.pushmodels.rich.carousel
- RichFeatures
- com.salesforce.marketingcloud.pushmodels.rich - Classes
- com.salesforce.marketingcloud.pushmodels.rich
- Message Class
- NotificationMessage
- PushKeys
- Region
- com.salesforce.marketingcloud.pushmodels - Classes
- com.salesforce.marketingcloud.pushmodels
- Push Models Module
- AddToCartEvent
- CancelOrderEvent
- CartEvent
- CatalogEvent
- CatalogObject
- CommentCatalogEvent
- DeliverOrderEvent
- EngagementEvent
- Event
- EventManager
- ExchangeOrderEvent
- FavoriteCatalogEvent
- LineItem
- Order
- OrderEvent
- PreorderEvent
- PurchaseOrderEvent
- QuickViewCatalogEvent
- RemoveFromCartEvent
- ReplaceCartEvent
- ReturnOrderEvent
- ReviewCatalogEvent
- ShareCatalogEvent
- ShipOrderEvent
- ViewCatalogDetailEvent
- ViewCatalogEvent
- com.salesforce.marketingcloud.sfmcsdk.components.events - Classes
- com.salesforce.marketingcloud.sfmcsdk.components.events
- AttributesEditor
- Identity Class
- IdentityEditor
- com.salesforce.marketingcloud.sfmcsdk.components.identity - Classes
- com.salesforce.marketingcloud.sfmcsdk.components.identity
- LogLevel
- com.salesforce.marketingcloud.sfmcsdk.components.logging - Enums
- LogListener Interface
- com.salesforce.marketingcloud.sfmcsdk.components.logging - Interfaces
- com.salesforce.marketingcloud.sfmcsdk.components.logging
- Salesforce Marketing Cloud Android SDK v11.0
- SFMCSdkInitializationStatus
- SFMCSdkModuleConfig
- com.salesforce.marketingcloud.sfmcsdk - Classes
- InitializationState
- com.salesforce.marketingcloud.sfmcsdk - Enums
- InitializationStatus
- SFMCSdkReadyListener
- com.salesforce.marketingcloud.sfmcsdk - Interfaces
- com.salesforce.marketingcloud.sfmcsdk
- SFMC SDK
- addTag
- clearAttribute
- Cordova Plugin API Reference
- disableLogging
- disablePush
- enableLogging
- enablePush
- getAttributes
- getContactKey
- getDeviceId
- getSystemToken
- getTags
- isAnalyticsEnabled
- isPiAnalyticsEnabled
- isPushEnabled
- logSdkState
- removeTag
- setAnalyticsEnabled
- setAttribute
- setContactKey
- setOnNotificationOpenedListener
- setOnUrlActionListener
- setPiAnalyticsEnabled
- track
- MCCordovaPlugin~notificationOpenedCallback
- MCCordovaPlugin~urlActionCallback
- Unified Mobile SDK Reference
- In-App Messaging
- Marketing Cloud Engagement SDK
- Marketing Cloud Mobile App Messaging SDK
- Push Messaging
- SFMC Core
- Flutter Unified Plugin API Reference
- Flutter Plugin for Marketing Cloud Engagement API Reference
- addTag
- clearAttribute
- deleteMessage
- disableLogging
- disablePush
- enableLogging
- enablePush
- getAttributes
- getContactKey
- getDeletedMessageCount
- getDeletedMessages
- getDeviceId
- getMessageCount
- getMessages
- getReadMessageCount
- getReadMessages
- getSystemToken
- getTags
- getUnreadMessageCount
- getUnreadMessages
- isAnalyticsEnabled
- isPiAnalyticsEnabled
- isPushEnabled
- logSdkState
- markAllMessagesDeleted
- markAllMessagesRead
- refreshInbox
- registerInboxResponseListener
- removeTag
- setAnalyticsEnabled
- setAttribute
- setContactKey
- setMessageRead
- setPiAnalyticsEnabled
- trackEvent
- unregisterInboxResponseListener
- Classes
- SFContentExtensionConfig
- SFNotificationServiceConfig
- Enums
- LogLevel
- MediaProviders
- Extension SDK (Rich Notifications)
- Classes
- InAppMessagingFeature
- InAppMessagingFeatureConfigBuilder
- IAM Feature Module (In-App Messaging)
- Salesforce Marketing Cloud iOS SDK v11
- Classes
- MobileAppMessaging
- MobileAppMessagingConfigBuilder
- MAM Core Module (Mobile App Messaging)
- MarketingCloudSdk
- MarketingCloudSdkConfigBuilder
- Classes
- MCE SDK (Marketing Cloud Engagement)
- Classes
- PushFeature
- PushFeatureConfigBuilder
- Push Feature Module
- CDP
- ConfigBuilder
- CustomEvent
- Identity
- InAppMessageCloseAction
- LogOutputter
- ModuleInitStatus
- PERSONALIZATION
- Classes
- SFMCSdk
- InAppMessageAlignment
- InAppMessageAnimationType
- InAppMessageButtonActionType
- InAppMessageButtonConfiguration
- InAppMessageCloseButtonAlignment
- InAppMessageDismissReason
- InAppMessageImageContentMode
- InAppMessageImageSize
- InAppMessageLayoutOrder
- InAppMessageSize
- InAppMessageType
- ModuleName
- OperationResult
- Enums
- URLType
- IdentityInfo
- IdentityModifier
- InAppMessageAnimation
- InAppMessageBorder
- InAppMessageButton
- InAppMessageCloseButton
- InAppMessageDetails
- InAppMessageEventDelegate
- InAppMessageMedia
- InAppMessageShadow
- InAppMessageSpacing
- InAppMessageTertiaryText
- InAppMessageText
- LocationDelegate
- ModuleConfig
- Protocols
- URLHandlingDelegate
- SFMC SDK (Foundation)
- React Native Unified Plugin API Reference
- In-App Messaging
- Marketing Cloud Engagement SDK
- Marketing Cloud Mobile App Messaging SDK
- Push Messaging
- SFMC Core
- React Native Plugin for Engagement API Reference
- addTag
- clearAttribute
- disableLogging
- disablePush
- enableLogging
- enablePush
- getAttributes
- getContactKey
- getDeviceId
- getSystemToken
- getTags
- isAnalyticsEnabled
- isPiAnalyticsEnabled
- isPushEnabled
- logSdkState
- removeTag
- setAnalyticsEnabled
- setAttribute
- setContactKey
- setPiAnalyticsEnabled
- track