Pauses or resumes outbound network requests from the Braze SDK at any point during runtime. Events are not lost during the offline state. Manual requests made from the Braze singleton will also be offline. Single shot requests in offline mode, (such as templating, image, and file requests) are lost and will not be repeated later. Basically, everything that is not an event logged to a session will be lost.

pendingConfigurations

private val pendingConfigurations: MutableList<BrazeConfig>

A queued list of BrazeConfig objects made to ".configure()" that will be applied once the singleton is instantiated.

sdkEnablementProvider

@VisibleForTesting

internal var sdkEnablementProvider: SdkEnablementProvider?

shouldMockNetworkRequestsAndDropEvents

private var shouldMockNetworkRequestsAndDropEvents: Boolean

shouldRequestFrameworkListenToNetworkUpdates

@VisibleForTesting

internal var shouldRequestFrameworkListenToNetworkUpdates: Boolean

staticExternalIEventMessenger

@VisibleForTesting

internal var staticExternalIEventMessenger: IEventMessenger?

An IEventMessenger to store client external subscriptions and survive calls to wipeData.

Functions

addSdkMetadata

@JvmStatic

fun addSdkMetadata(context: Context, sdkMetadata: EnumSet<BrazeSdkMetadata>)

clearDataStoreData

private fun clearDataStoreData(context: Context)

clearEndpointProvider

@JvmStatic

fun clearEndpointProvider()

Clear the currently set IBrazeEndpointProvider.

clearInstance

@VisibleForTesting(otherwise = 5)

internal fun clearInstance()

clearSharedPreferencesData

private fun clearSharedPreferencesData(context: Context)

configure

@JvmStatic

fun configure(context: Context, config: BrazeConfig?): Boolean

Optional static method to set configuration values for the Braze singleton, overriding whatever values are present in the braze.xml. Calling this method at the beginning of each app run is encouraged.

disableDelayedInitialization

@JvmStatic

fun disableDelayedInitialization(context: Context)

Disables delayed initialization after an invocation of Braze.enableDelayedInitialization or after setting com_braze_enable_delayed_initialization to true in braze.xml. Note that this feature is disabled by default.

disableSdk

@JvmStatic

fun disableSdk(context: Context)

Disables the Braze SDK. This call persists across Braze SDK instances until Braze.enableSdk is called.

enableDelayedInitialization

@JvmStatic

fun enableDelayedInitialization(context: Context, analyticsBehavior: DelayedInitializationAnalyticsBehavior = DelayedInitializationAnalyticsBehavior.QUEUE)

Enables delayed initialization. This call persists across Braze SDK instances until Braze.disableDelayedInitialization is called.

enableMockNetworkRequestsAndDropEventsMode

@JvmStatic

fun enableMockNetworkRequestsAndDropEventsMode(): Boolean

Testing utility method that enables mocking for all Braze SDK network requests, essentially turning the SDK "off".

enableSdk

@JvmStatic

fun enableSdk(context: Context)

Enables the Braze SDK after an invocation of Braze.disableSdk. Note that the Braze SDK is enabled by default.

getApiEndpoint

@JvmStatic

fun getApiEndpoint(brazeEndpoint: Uri): Uri

If an IBrazeEndpointProvider is configured, that provider's delegate is used to generate the Uri for the Braze API endpoint. Otherwise, return the Uri given.

getConfiguredApiKey

@JvmStatic

fun getConfiguredApiKey(configurationProvider: BrazeConfigurationProvider): String?

A helper method to determine if the SDK is configured with an API key. Note that the SDK should not be called without a configured API key under any circumstances.

getDelayedInitializationProvider

@VisibleForTesting

internal fun getDelayedInitializationProvider(context: Context): DelayedInitializationProvider

getInstance

@JvmStatic

fun getInstance(context: Context): Braze

Static method that returns the latest Braze instance. All requests to Braze are made through this instance. There are no guarantees that previous instances will be the same so do not cache returned instances.

getSdkEnablementProvider

private fun getSdkEnablementProvider(context: Context): SdkEnablementProvider

requestTriggersIfInAppMessageTestPush

@VisibleForTesting

internal fun requestTriggersIfInAppMessageTestPush(intent: Intent, brazeManager: IBrazeManager)

Requests triggers on the BrazeManager object if the Intent represents a test in-app message push.

setConfiguredCustomEndpoint

@VisibleForTesting

internal fun setConfiguredCustomEndpoint(configuredCustomEndpoint: String?)

Creates an IBrazeEndpointProvider for any endpoint configured via braze.xml or BrazeConfig.

setEndpointProvider

@JvmStatic

fun setEndpointProvider(endpointProvider: IBrazeEndpointProvider?)

Sets an IBrazeEndpointProvider to be used to route Braze API traffic

shouldAllowSingletonInitialization

private fun shouldAllowSingletonInitialization(): Boolean

stopInstance

@VisibleForTesting

internal fun stopInstance(clearStorage: Boolean)

Stops the instance by shutting down or cancelling any work on the SDK. Note that this renders the current instance SDK unusable.

wipeData

@JvmStatic

fun wipeData(context: Context)

Hard resets all data created by the Braze SDK from the internal storage directory. Note that any in-flight actions such as event logging, data syncing, etc. will be cancelled as a result of this call.