Batch Android SDK/com.batch.android/Batch/Messaging/LifecycleListener

LifecycleListener

Listener interface for messaging views lifecycle events.

Implement this if you want to be notified of what happens to the messaging view (for example, perform some analytics on show/hide). You're also required to implement this if you want to add actions with a "callback" type.

Types

MessagingCloseReason

enum MessagingCloseReason

Enum for the different reasons why an In-App message can be closed.

Functions

onBatchMessageActionTriggered

open fun onBatchMessageActionTriggered(@Nullable messageIdentifier: String, @Nullable ctaIdentifier: String, @NonNull action: BatchMessageAction)

Called when the message view will be dismissed due to the user pressing a CTA or the global tap action.

onBatchMessageClosed

abstract fun onBatchMessageClosed(@Nullable messageIdentifier: String, reason: Batch.Messaging.LifecycleListener.MessagingCloseReason)

Called when the message view disappeared from the screen.

onBatchMessageShown

abstract fun onBatchMessageShown(@Nullable messageIdentifier: String)

Called when the message view appeared on screen.