Examples

Examples

The SDK repository includes native demo applications for Android and iOS.

Android example app

Path:

example-android/

What it demonstrates:

• consuming the published Android package com.deepdots.sdk:shared-android:0.7.0
• initialization with a publicKey
• user metadata through metadata = mapOf("userId" to userId)
• path updates for /login, /home, and detail routes
• event listeners for popup lifecycle events
• manual triggering of a popup
• event-driven and scroll-driven flows in the demo UI

Android local example app

Path:

example-android-local/

What it demonstrates:

• consuming the local :shared module directly during repository development
• validating SDK behavior without relying on the published Android artifact

iOS example app

Path:

iosApp/

What it demonstrates:

• initialization from Swift
• attaching PlatformContext from a root view controller
• navigation-driven path updates
• scroll percentage reporting via onScroll
• custom event triggering
• binary Swift Package consumption through DeepdotsSDK

Recommended validation flow for stakeholders

1. Use the Android or iOS demo app to validate timing, UX placement, and event behavior.
2. Confirm path naming with the screens used in the production host app.
3. Verify popup lifecycle events against analytics expectations.
4. Confirm the popups configured in Deepdots load and behave as expected in the app.

For a production integration, see the best practices.