Overlay In-App
An in-app overlay is a view displayed above the currently visible activity, view, or page. It covers the content beneath it and prevents interaction with the application while visible. By default, it has a close button. Use the following methods to pause, resume, or check the display state of in-app overlays.
Resuming
Enables or resumes the display of in-app overlays. This is the default state.
- Android
- Kotlin Multiplatform
- iOS
- Web
EngagementCloud.inApp.resume()
EngagementCloud.inApp.resume()
await EngagementCloud.shared.inApp.resume()
This feature is not supported on Web.
Pausing
Pauses the display of in-app overlays. Call this method to prevent in-app overlays from appearing during sensitive flows, such as payment or data entry. For more details, see SDK Lifecycle.
- Android
- Kotlin Multiplatform
- iOS
- Web
EngagementCloud.inApp.pause()
EngagementCloud.inApp.pause()
await EngagementCloud.shared.inApp.pause()
This feature is not supported on Web.
Checking Pause State
Returns the current setting for in-app display as a boolean value.
- Android
- Kotlin Multiplatform
- iOS
- Web
EngagementCloud.inApp.isPaused
EngagementCloud.inApp.isPaused
await EngagementCloud.shared.inApp.isPaused
This feature is not supported on Web.
Display Lifecycle
| Stage | Description |
|---|---|
| Eligible | Triggered event matches campaign conditions |
| Queued | Waiting for a safe display moment, for example when the overlay is not paused |
| Displayed | Overlay visible, underlying UI blocked |
| Dismissed | User closes overlay or an action triggers navigation |
Overlay Content and Navigation
Ensure your overlays do not replicate native navigation components. Keep overlay content focused on its headline and call to action.
When to Pause an Overlay
Pause during the following contexts:
- Payment and checkout flows
- Sensitive data entry
- Onboarding tutorials
To restore engagement, resume the overlay when the user leaves those contexts.
Action Handling
For more information, refer to event handling.