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

Companion

object Companion

Properties

customBrazeNotificationFactory

var customBrazeNotificationFactory: IBrazeNotificationFactory?

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

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.

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.

Functions

addSdkMetadata

fun addSdkMetadata(context: <Error class: unknown class>, sdkMetadata: EnumSet<BrazeSdkMetadata>)

clearEndpointProvider

fun clearEndpointProvider()

Clear the currently set IBrazeEndpointProvider.

configure

fun configure(context: <Error class: unknown class>, 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: <Error class: unknown class>)

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: <Error class: unknown class>)

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

enableDelayedInitialization

fun enableDelayedInitialization(context: <Error class: unknown class>, 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: <Error class: unknown class>)

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

getApiEndpoint

fun getApiEndpoint(brazeEndpoint: <Error class: unknown class>): <Error class: unknown class>

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.

getInstance

fun getInstance(context: <Error class: unknown class>): 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.

setEndpointProvider

fun setEndpointProvider(endpointProvider: IBrazeEndpointProvider?)

Sets an IBrazeEndpointProvider to be used to route Braze API traffic

wipeData

fun wipeData(context: <Error class: unknown class>)

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.