com.braze

Class BrazeActivityLifecycleCallbackListener

java.lang.Object

com.braze.BrazeActivityLifecycleCallbackListener

All Implemented Interfaces:

android.app.Application.ActivityLifecycleCallbacks

Direct Known Subclasses:

AppboyLifecycleCallbackListener

public class BrazeActivityLifecycleCallbackListener
extends java.lang.Object
implements android.app.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.

Constructor Summary

Constructors

Constructor and Description
BrazeActivityLifecycleCallbackListener() A default constructor equivalent to calling BrazeActivityLifecycleCallbackListener(true, true, Collections.emptySet(), Collections.emptySet())
BrazeActivityLifecycleCallbackListener(boolean sessionHandlingEnabled, boolean registerInAppMessageManager)
BrazeActivityLifecycleCallbackListener(boolean sessionHandlingEnabled, boolean registerInAppMessageManager, java.util.Set<java.lang.Class<?>> inAppMessagingRegistrationBlocklist, java.util.Set<java.lang.Class<?>> sessionHandlingBlocklist)
BrazeActivityLifecycleCallbackListener(java.util.Set<java.lang.Class<?>> inAppMessagingRegistrationBlocklist) Constructor that only sets a blocklist for BrazeInAppMessageManager registration and enables BrazeInAppMessageManager registration.
BrazeActivityLifecycleCallbackListener(java.util.Set<java.lang.Class<?>> inAppMessagingRegistrationBlocklist, java.util.Set<java.lang.Class<?>> sessionHandlingBlocklist) Constructor that sets a blocklist for session handling and BrazeInAppMessageManager registration while also enabling both features.

Method Summary

Modifier and Type	Method and Description
void	onActivityCreated(android.app.Activity activity, android.os.Bundle bundle)
void	onActivityDestroyed(android.app.Activity activity)
void	onActivityPaused(android.app.Activity activity)
void	onActivityResumed(android.app.Activity activity)
void	onActivitySaveInstanceState(android.app.Activity activity, android.os.Bundle bundle)
void	onActivityStarted(android.app.Activity activity)
void	onActivityStopped(android.app.Activity activity)
void	setInAppMessagingRegistrationBlacklist(java.util.Set<java.lang.Class<?>> blocklist) Deprecated. Please use setInAppMessagingRegistrationBlocklist(Set)
void	setInAppMessagingRegistrationBlocklist(java.util.Set<java.lang.Class<?>> blocklist) Sets the Object.getClass() blocklist for which in-app message registration will not occur.
void	setSessionHandlingBlacklist(java.util.Set<java.lang.Class<?>> blocklist) Deprecated. Please use setSessionHandlingBlocklist(Set)
void	setSessionHandlingBlocklist(java.util.Set<java.lang.Class<?>> blocklist) Sets the Object.getClass() blocklist for which session handling will not occur.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.app.Application.ActivityLifecycleCallbacks

onActivityPostCreated, onActivityPostDestroyed, onActivityPostPaused, onActivityPostResumed, onActivityPostSaveInstanceState, onActivityPostStarted, onActivityPostStopped, onActivityPreCreated, onActivityPreDestroyed, onActivityPrePaused, onActivityPreResumed, onActivityPreSaveInstanceState, onActivityPreStarted, onActivityPreStopped

Constructor Detail

BrazeActivityLifecycleCallbackListener

public BrazeActivityLifecycleCallbackListener()

A default constructor equivalent to calling BrazeActivityLifecycleCallbackListener(true, true, Collections.emptySet(), Collections.emptySet())

BrazeActivityLifecycleCallbackListener

public BrazeActivityLifecycleCallbackListener(boolean sessionHandlingEnabled,
                                              boolean registerInAppMessageManager)

Parameters:

sessionHandlingEnabled - When true, handles calling openSession and closeSession in Application.ActivityLifecycleCallbacks#onActivityStarted(Activity) (Activity)} and Application.ActivityLifecycleCallbacks#onActivityStopped(Activity) (Activity)} respectively.

registerInAppMessageManager - When true, registers and unregisters the InAppMessageManager in Application.ActivityLifecycleCallbacks#onActivityResumed and Application.ActivityLifecycleCallbacks#onActivityPaused(Activity) respectively.

BrazeActivityLifecycleCallbackListener

public BrazeActivityLifecycleCallbackListener(java.util.Set<java.lang.Class<?>> inAppMessagingRegistrationBlocklist,
                                              java.util.Set<java.lang.Class<?>> sessionHandlingBlocklist)

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

Parameters:

inAppMessagingRegistrationBlocklist - A set of Activitys for which in-app message registration will not occur. Each class should be retrieved via Object.getClass().

sessionHandlingBlocklist - A set of Activitys for which session handling will not occur. Each class should be retrieved via Object.getClass().

BrazeActivityLifecycleCallbackListener

public BrazeActivityLifecycleCallbackListener(java.util.Set<java.lang.Class<?>> inAppMessagingRegistrationBlocklist)

Constructor that only sets a blocklist for BrazeInAppMessageManager registration and enables BrazeInAppMessageManager registration. Session handling is enabled and has an empty blocklist.

Parameters:

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

BrazeActivityLifecycleCallbackListener

public BrazeActivityLifecycleCallbackListener(boolean sessionHandlingEnabled,
                                              boolean registerInAppMessageManager,
                                              java.util.Set<java.lang.Class<?>> inAppMessagingRegistrationBlocklist,
                                              java.util.Set<java.lang.Class<?>> sessionHandlingBlocklist)

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(Activity) respectively.

inAppMessagingRegistrationBlocklist - A set of Activitys for which in-app message registration will not occur. Each class should be retrieved via Object.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 Object.getClass(). If null, an empty set is used instead.

Method Detail

setInAppMessagingRegistrationBlacklist

@Deprecated
public void setInAppMessagingRegistrationBlacklist(java.util.Set<java.lang.Class<?>> blocklist)

Deprecated. Please use setInAppMessagingRegistrationBlocklist(Set)

setInAppMessagingRegistrationBlocklist

public void setInAppMessagingRegistrationBlocklist(java.util.Set<java.lang.Class<?>> blocklist)

Sets the Object.getClass() blocklist for which in-app message registration will not occur.

setSessionHandlingBlacklist

@Deprecated
public void setSessionHandlingBlacklist(java.util.Set<java.lang.Class<?>> blocklist)

Deprecated. Please use setSessionHandlingBlocklist(Set)

setSessionHandlingBlocklist

public void setSessionHandlingBlocklist(java.util.Set<java.lang.Class<?>> blocklist)

Sets the Object.getClass() blocklist for which session handling will not occur.

onActivityStarted

public void onActivityStarted(android.app.Activity activity)

Specified by:

onActivityStarted in interface android.app.Application.ActivityLifecycleCallbacks

onActivityStopped

public void onActivityStopped(android.app.Activity activity)

Specified by:

onActivityStopped in interface android.app.Application.ActivityLifecycleCallbacks

onActivityResumed

public void onActivityResumed(android.app.Activity activity)

Specified by:

onActivityResumed in interface android.app.Application.ActivityLifecycleCallbacks

onActivityPaused

public void onActivityPaused(android.app.Activity activity)

Specified by:

onActivityPaused in interface android.app.Application.ActivityLifecycleCallbacks

onActivityCreated

public void onActivityCreated(android.app.Activity activity,
                              android.os.Bundle bundle)

Specified by:

onActivityCreated in interface android.app.Application.ActivityLifecycleCallbacks

onActivitySaveInstanceState

public void onActivitySaveInstanceState(android.app.Activity activity,
                                        android.os.Bundle bundle)

Specified by:

onActivitySaveInstanceState in interface android.app.Application.ActivityLifecycleCallbacks

onActivityDestroyed

public void onActivityDestroyed(android.app.Activity activity)

Specified by:

onActivityDestroyed in interface android.app.Application.ActivityLifecycleCallbacks