braze-android-sdk/com.braze/BrazeActivityLifecycleCallbackListener

BrazeActivityLifecycleCallbackListener

open class BrazeActivityLifecycleCallbackListener @JvmOverloads constructor(sessionHandlingEnabled: Boolean = true, registerInAppMessageManager: Boolean = true, inAppMessagingRegistrationBlocklist: Set<Class<*>?>? = emptySet<Class<*>>(), sessionHandlingBlocklist: Set<Class<*>?>? = emptySet<Class<*>>()) : Application.ActivityLifecycleCallbacks

Can be used to automatically handle Braze lifecycle methods. Optionally, openSession() and closeSession() are called on onActivityStarted and onActivityStopped respectively. The InAppMessageManager methods of registerInAppMessageManager() and unregisterInAppMessageManager() can be optionally called here as well. Note: This callback should not be set in any Activity. It must be set in the Application class of your app.

Parameters

sessionHandlingEnabled

When true, handles calling openSession and closeSession in onActivityStarted and onActivityStopped respectively.

registerInAppMessageManager

When true, registers and unregisters the BrazeInAppMessageManager in Application.ActivityLifecycleCallbacks.onActivityResumed and Application.ActivityLifecycleCallbacks.onActivityPaused respectively.

inAppMessagingRegistrationBlocklist

A set of Activitys for which in-app message registration will not occur. Each class should be retrieved via Activity.getClass. If null, an empty set is used instead.

sessionHandlingBlocklist

A set of Activitys for which session handling will not occur. Each class should be retrieved via Activity.getClass. If null, an empty set is used instead.

Constructors

BrazeActivityLifecycleCallbackListener

constructor(sessionHandlingEnabled: Boolean = true, registerInAppMessageManager: Boolean = true, inAppMessagingRegistrationBlocklist: Set<Class<*>?>? = emptySet<Class<*>>(), sessionHandlingBlocklist: Set<Class<*>?>? = emptySet<Class<*>>())

constructor(inAppMessagingRegistrationBlocklist: Set<Class<*>?>?, sessionHandlingBlocklist: Set<Class<*>?>? = emptySet<Class<*>>())

Constructor that sets a blocklist for session handling and BrazeInAppMessageManager registration while also enabling both features.

Properties

shouldPersistWebView

@VisibleForTesting

var shouldPersistWebView: Boolean?

Functions

onActivityCreated

open override fun onActivityCreated(activity: Activity, bundle: Bundle?)

onActivityDestroyed

open override fun onActivityDestroyed(activity: Activity)

onActivityPaused

open override fun onActivityPaused(activity: Activity)

onActivityPostCreated

open fun onActivityPostCreated(activity: Activity, savedInstanceState: Bundle?)

onActivityPostDestroyed

open fun onActivityPostDestroyed(activity: Activity)

onActivityPostPaused

open fun onActivityPostPaused(activity: Activity)

onActivityPostResumed

open fun onActivityPostResumed(activity: Activity)

onActivityPostSaveInstanceState

open fun onActivityPostSaveInstanceState(activity: Activity, outState: Bundle)

onActivityPostStarted

open fun onActivityPostStarted(activity: Activity)

onActivityPostStopped

open fun onActivityPostStopped(activity: Activity)

onActivityPreCreated

open fun onActivityPreCreated(activity: Activity, savedInstanceState: Bundle?)

onActivityPreDestroyed

open fun onActivityPreDestroyed(activity: Activity)

onActivityPrePaused

open fun onActivityPrePaused(activity: Activity)

onActivityPreResumed

open fun onActivityPreResumed(activity: Activity)

onActivityPreSaveInstanceState

open fun onActivityPreSaveInstanceState(activity: Activity, outState: Bundle)

onActivityPreStarted

open fun onActivityPreStarted(activity: Activity)

onActivityPreStopped

open fun onActivityPreStopped(activity: Activity)

onActivityResumed

open override fun onActivityResumed(activity: Activity)

onActivitySaveInstanceState

open override fun onActivitySaveInstanceState(activity: Activity, bundle: Bundle)

onActivityStarted

open override fun onActivityStarted(activity: Activity)

onActivityStopped

open override fun onActivityStopped(activity: Activity)

registerOnApplication

fun registerOnApplication(context: Context)

Registers this listener directly against the Application. Equivalent to:

setInAppMessagingRegistrationBlocklist

fun setInAppMessagingRegistrationBlocklist(blocklist: Set<Class<*>?>)

Sets the Activity.getClass blocklist for which in-app message registration will not occur.

setSessionHandlingBlocklist

fun setSessionHandlingBlocklist(blocklist: Set<Class<*>?>)

Sets the Activity.getClass blocklist for which session handling will not occur.

shouldHandleLifecycleMethodsInActivity

@VisibleForTesting

fun shouldHandleLifecycleMethodsInActivity(activity: Activity, forSessionHandling: Boolean): Boolean

Determines if this Activity should be ignored for the purposes of session tracking or in-app message registration.