Package-level declarations

Types

class Braze @VisibleForTesting constructor(context: Context) : IBraze

Primary implementation of IBraze. Provides methods for tracking analytics, managing user identity, handling push notifications, Content Cards, Feature Flags, in-app messages, and other Braze SDK features.

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.

BrazeBootReceiver

open class BrazeBootReceiver : BroadcastReceiver

BroadcastReceiver that initializes the Braze SDK on device boot to re-register geofences, which Android unregisters on reboot.

BrazeFlushPushDeliveryReceiver

open class BrazeFlushPushDeliveryReceiver : BroadcastReceiver

BrazeInternal

object BrazeInternal

BrazeInternal is solely for the use of other packages within the Braze SDK for Android. Use of any of the classes in this package is unsupported, and they may be modified or removed without warning at any time.

BrazeUser

class BrazeUser(val userCache: UserCache, val brazeManager: IBrazeManager, var internalUserId: String, val locationManager: ILocationManager, val serverConfigStorageProvider: ServerConfigStorageProvider)

Represents the current Braze user and provides methods for setting user attributes, custom attributes, and subscription states.

Constants

object Constants

Contains Constants used by multiple classes.

IBraze

interface IBraze

The public interface for the Braze SDK. This interface is used to send and receive data to and from Braze.

IBrazeDeeplinkHandler

interface IBrazeDeeplinkHandler

This class defines the actions that should be taken when Braze attempts to follow a deeplink.

IBrazeEndpointProvider

fun interface IBrazeEndpointProvider

IBrazeNotificationFactory

fun interface IBrazeNotificationFactory