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

Messaging

class Messaging

Batch Messaging module

Types

Link copied to clipboard
open class DisplayHint
Link copied to clipboard
Link copied to clipboard
interface InAppInterceptor
Interface to intercept In-App Messages before they are displayed.
Link copied to clipboard
interface LifecycleListener
Listener interface for messaging views lifecycle events.

Properties

Link copied to clipboard
val GLOBAL_TAP_ACTION_INDEX: String = "mepCtaIndex:-1"
CTA Index representing a global tap action

Functions

Link copied to clipboard
open fun hasPendingMessage(): Boolean
Check if Batch currently has a pending message, without forgetting it.
Link copied to clipboard
open fun isDoNotDisturbEnabled(): Boolean
Check if Batch Messaging is currently in Do Not Disturb mode
Link copied to clipboard
@NonNull
open fun loadMessagingView(@NonNull context: Context, @NonNull message: BatchMessage): BatchMessagingView
Load the BatchMessagingView corresponding to the message payload.
Link copied to clipboard
@Nullable
open fun popPendingMessage(): BatchMessage
Gets the currently enqueued message.
Link copied to clipboard
open fun setAutomaticMode(automatic: Boolean)
Toggle this module's automatic mode.
Link copied to clipboard
open fun setDoNotDisturbEnabled(enableDnd: Boolean)
Toggles whether Batch.Messaging should enter its "do not disturb" (DnD) mode, or exit it.
Link copied to clipboard
open fun setInAppInterceptor(@Nullable interceptor: Batch.Messaging.InAppInterceptor)
Set an In-App interceptor.
Link copied to clipboard
open fun setLifecycleListener(@Nullable listener: Batch.Messaging.LifecycleListener)
Set a lifecycle listener.
Link copied to clipboard
open fun setShowForegroundLandings(showForegroundLandings: Boolean)
Toggle whether mobile landings should be shown directly rather than displaying a notification when the app is in foreground.
Link copied to clipboard
open fun setTypefaceOverride(@Nullable normalTypeface: Typeface, @Nullable boldTypeface: Typeface)
Override the Typeface (aka font) used by Batch's messaging views.
Link copied to clipboard
open fun show(@NonNull context: Context, @NonNull message: BatchMessage)
Asynchronously show the BatchMessage.