API Reference

This section provides guidance around references provided with the Engagement Mobile SDK.

  • Initialization

    Before the Data Cloud Module for the Engagement Mobile SDK can be used to invoke web services using the API, the SDK must be configured. Use the CdpConfigBuilder for iOS or CdpConfig.Builder for Android helper class to build your SDK configuration by providing required settings appId and endpoint that can be obtained from your Mobile Connector. Optionally, configuration can be provided for the settings trackScreens, trackLifecycle, and sessionTimeoutInSeconds.

  • Capturing Engagement Data

    The Data Cloud Module for the Engagement Mobile SDK enables collection of granular data about the customer’s mobile app interactions through event tracking.

  • Capturing Profile Data

    The Data Cloud Module for the Engagement Mobile SDK enables collection of profile data through the SDK’s Identity APIs.

  • Capturing Behavior Data

    The Data Cloud Module for the Engagement Mobile SDK enables the collection of granular data about a customer’s mobile app interactions through event tracking.

  • Consent Management

    Engagement Mobile SDK offers a managed solution for allowing and restricting collection of event data. Your mobile application is responsible for presenting the device owner with the choice to opt in or opt out of data collection and for setting the Data Cloud Module consent property accordingly.

  • Location Tracking

    The Data Cloud Module for the Engagement Mobile SDK supports location tracking for all events. Enable this functionality using the setLocation method on the Data Cloud Module to set coordinates and expiresIn.

  • Logging and Debugging

    Logging is optional, yet critical, SDK feature that allows the mobile application developer to select the verbosity of the Data Cloud Module for the Engagement Mobile SDK’s output. By default, logging is disabled and must be enabled using the setLogger for iOS or setLogging for Android method on the SFMCSdk instance. Define the desired logging level and output destination. Enabling logging results in log capture 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.