Android SDK Common Integration Scenarios

ENGAGE® Android SDK Common Integration Scenarios

Not all integrations are the same, but a few of the most common integration scenarios for the Android ENGAGE SDK will be covered.

Scenario 1

Host App does not use Firebase, SDK uses First Orion Firebase

The host app does not use its own Firebase Cloud Messaging but relies upon the SDK's built-in FCM Implementation.

  • No additional work is required to get started with the SDK.
  • Follow the integration laid out in the Android SDK Quick Start guide.

Scenario 2

Host App uses its own Firebase, SDK uses First Orion Firebase

Recommended Integration Path

The host app has its own instance of Firebase Cloud Messaging, but the SDK will use First Orion's Firebase.

  • Since all Firebase traffic is funneled through a single service, additional logic needs to be implemented to differentiate between ENGAGE content and the host apps own Firebase content.
  • Refer to Firebase guide for Firebase integration.

Scenario 3

SDK uses Host App's Firebase

By default, the ENGAGE SDK uses First Orion's Firebase instance to handle ENGAGE content pushes. This can be paired with the host app's own Firebase instance, allowing the ENGAGE SDK to use First Orion's Firebase instance to handle all ENGAGE-related functionality and the host app to use their own Firebase instance to deal with their own non-ENGAGE-related functionality. Refer to Scenario 2.

ENGAGE can be configured to skip First Orion's Firebase instance and use the host app's Firebase instance instead. Under the rare circumstance that the host app requires its own Firebase instance for ENGAGE instead of using First Orion's Firebase instance, please reach out to the First Orion platform team.


Scenario 4

Host app uses OneSignal, SDK uses First Orion Firebase

The host app uses OneSignal or another library that includes a Firebase/FCM Implementation, but the ENGAGE SDK will use First Orion's Firebase.

  • No extra work is needed if the host app is using OneSignal (see Integration Scenario 1).
  • Your mileage may vary depending on changes to priority for FCM.

📘

NOTE

Reach out to First Orion if you encounter any issues with integration while using other 3rd-party libraries that utilize FCM.