API Reference

This section provides comprehensive documentation for the Engagement Mobile SDK APIs and features.

Initialization: Configure the Data Cloud Module before using any API services. Use CdpConfigBuilder (iOS) or CdpConfig.Builder (Android) to build your SDK configuration with required settings like appId and endpoint from your Mobile Connector. Optionally, configure the trackScreens, trackLifecycle, and sessionTimeoutInSeconds settings.
Capturing Engagement Data: Collect granular data about customer mobile app interactions through comprehensive event tracking capabilities.
Capturing Profile Data: Gather profile data through the SDK's Identity APIs to build comprehensive customer profiles.
Capturing Behavior Data: Track detailed customer behavior patterns and mobile app interactions through advanced event tracking.
Consent Management: Implement managed consent solutions for data collection. Your mobile application handles presenting opt-in or opt-out choices to users and sets the Data Cloud Module consent property accordingly.
Location Tracking: Enable location tracking for all events using the setLocation method. Configure coordinates and expiresIn parameters for precise location data collection.
Logging and Debugging: Configure SDK logging for development and debugging. Use setLogger (iOS) or setLogging (Android) on the SFMCSdk instance to enable logging with customizable logging levels and output destinations. Logs are captured using the native unified logging system.
Post Data from an Authenticated Server-to-Server Connection: Use the POST method to send event data through an authenticated server-to-server connection. Use a server-to-server connection when your server already collects engagement data that you want to forward to Data Cloud or when you require an authenticated connection.
Post Data from an Unauthenticated Server-to-Server Connection: Use the POST method to send event data through an unauthenticated server-to-server connection. Use an unauthenticated server-to-server connection when your server already collects engagement data that you want to forward to Data Cloud and you don’t require an authenticated connection.