android-sdk-base/com.braze/Braze/Companion

Companion

object Companion

Properties

areOutboundNetworkRequestsOffline

private var areOutboundNetworkRequestsOffline: Boolean

brazeClassLock

private val brazeClassLock: ReentrantLock

clearConfigSentinel

private val clearConfigSentinel: BrazeConfig

A sentinel value denoting that the runtime configuration's cache should be cleared.

customBrazeNotificationFactory

var customBrazeNotificationFactory: IBrazeNotificationFactory?

A custom IBrazeNotificationFactory to be used to modify or create Braze push notifications.

delayedInitializationProvider

internal var delayedInitializationProvider: ERROR CLASS: Symbol not found for DelayedInitializationProvider??

deviceDataProvider

internal var deviceDataProvider: ERROR CLASS: Symbol not found for IDeviceDataProvider??

endpointProvider

private var endpointProvider: IBrazeEndpointProvider?

endpointProviderLock

private val endpointProviderLock: ReentrantLock

instance

private var instance: Braze?

isDelayedInitializationEnabled

val isDelayedInitializationEnabled: Boolean

Returns whether delayed initialization is enabled when either:

isDisabled

val isDisabled: Boolean

Returns whether the SDK is disabled when either:

isSdkDisabledOrDelayed

val isSdkDisabledOrDelayed: Boolean

Returns whether the SDK is disabled or delayed initialization is enabled.

KNOWN_APP_CRAWLER_DEVICE_MODELS

private val KNOWN_APP_CRAWLER_DEVICE_MODELS: ERROR CLASS: Unresolved name: setOf

A list of device models matching known app crawlers. All device models must be in lowercase.

NECESSARY_BRAZE_SDK_PERMISSIONS

private val NECESSARY_BRAZE_SDK_PERMISSIONS: ERROR CLASS: Unresolved name: setOf

outboundNetworkRequestsOffline

var outboundNetworkRequestsOffline: Boolean

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: ERROR CLASS: Unresolved name: mutableListOf

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

sdkEnablementProvider

internal var sdkEnablementProvider: ERROR CLASS: Symbol not found for SdkEnablementProvider??

shouldMockNetworkRequestsAndDropEvents

private var shouldMockNetworkRequestsAndDropEvents: Boolean

shouldRequestFrameworkListenToNetworkUpdates

internal var shouldRequestFrameworkListenToNetworkUpdates: Boolean

staticExternalIEventMessenger

internal var staticExternalIEventMessenger: ERROR CLASS: Symbol not found for IEventMessenger??

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

Functions

addSdkMetadata

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

Adds BrazeSdkMetadata entries to the SDK metadata set, which is sent with device data to identify wrapper SDK integrations.

clearDataStoreData

private fun clearDataStoreData(context: Context)

clearEndpointProvider

fun clearEndpointProvider()

Clear the currently set IBrazeEndpointProvider.

clearInstance

internal fun clearInstance()

clearSharedPreferencesData

private fun clearSharedPreferencesData(context: Context)

configure

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

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

fun disableSdk(context: Context)

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

enableDelayedInitialization

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

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

enableMockNetworkRequestsAndDropEventsMode

fun enableMockNetworkRequestsAndDropEventsMode(): Boolean

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

enableSdk

fun enableSdk(context: Context)

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

getApiEndpoint

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

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

internal fun getDelayedInitializationProvider(context: Context): ERROR CLASS: Symbol not found for DelayedInitializationProvider

getInstance

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): ERROR CLASS: Symbol not found for SdkEnablementProvider

requestTriggersIfInAppMessageTestPush

internal fun requestTriggersIfInAppMessageTestPush(intent: Intent, brazeManager: ERROR CLASS: Symbol not found for IBrazeManager)

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

setConfiguredCustomEndpoint

internal fun setConfiguredCustomEndpoint(configuredCustomEndpoint: String?)

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

setEndpointProvider

fun setEndpointProvider(endpointProvider: IBrazeEndpointProvider?)

Sets an IBrazeEndpointProvider to be used to route Braze API traffic

shouldAllowSingletonInitialization

private fun shouldAllowSingletonInitialization(): Boolean

stopInstance

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

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.