braze-android-sdk/com.braze.configuration/BrazeConfigurationProvider

BrazeConfigurationProvider

open class BrazeConfigurationProvider(context: Context) : CachedConfigurationProvider

Provides configuration values for the Braze SDK. Values are retrieved from the runtime configuration settings if present but default to the values from the braze.xml file. After retrieval, each configuration value is cached for performance.

Constructors

fun BrazeConfigurationProvider(context: Context)

Types

Companion

object Companion

Functions

clear

fun clear()

getBooleanValue

fun getBooleanValue(primaryKey: String, defaultValue: Boolean): Boolean

Attempts to find the mapped value for the primary key, then the secondary key. A found value for the primary key will always take precedence over the secondary key. The configuration cache will update using the primary key, even if the secondary key has the mapped value.

getColorValue

@ColorInt

fun getColorValue(primaryKey: String): Int?

getConfigurationValue

fun getConfigurationValue(type: CachedConfigurationProvider.ResourceType, key: String, defaultValue: Any?): Any?

Performs retrieval of a given resource type from the varying levels of caches using the primary and secondary keys.

getIntValue

fun getIntValue(primaryKey: String, defaultValue: Int): Int

getStringSetValue

fun getStringSetValue(primaryKey: String, defaultValue: Set<String>?): Set<String>?

getStringValue

fun getStringValue(primaryKey: String, defaultValue: String?): String?

getValueFromResources

fun getValueFromResources(type: CachedConfigurationProvider.ResourceType, resourceId: Int): Any

Queries the context resources for a given resource identifier.

readResourceValue

fun readResourceValue(type: CachedConfigurationProvider.ResourceType, key: String, defaultValue: Any?): Any?

Properties

applicationIconResourceId

val applicationIconResourceId: Int

baseUrlForRequests

val baseUrlForRequests: String

brazeApiKey

val brazeApiKey: BrazeApiKey

configurationCache

val configurationCache: MutableMap<String, Any?>

customEndpoint

val customEndpoint: String?

customHtmlWebViewActivityClassName

val customHtmlWebViewActivityClassName: String?

customLocationProviderNames

val customLocationProviderNames: EnumSet<LocationProviderName>

defaultNotificationAccentColor

@get:ColorInt

val defaultNotificationAccentColor: Int

defaultNotificationChannelDescription

val defaultNotificationChannelDescription: String

defaultNotificationChannelName

val defaultNotificationChannelName: String

deviceObjectAllowlist

val deviceObjectAllowlist: EnumSet<DeviceKey>

deviceObjectWhitelist

val deviceObjectWhitelist: EnumSet<DeviceKey>

doesHandlePushDeepLinksAutomatically

val doesHandlePushDeepLinksAutomatically: Boolean

doesPushStoryDismissOnClick

val doesPushStoryDismissOnClick: Boolean

ephemeralEventKeys

val ephemeralEventKeys: Set<String>

firebaseCloudMessagingSenderIdKey

val firebaseCloudMessagingSenderIdKey: String?

Gets the sender ID key used to register for Firebase Cloud Messaging.

inAppMessageWebViewClientOnPageFinishedMaxWaitMs

val inAppMessageWebViewClientOnPageFinishedMaxWaitMs: Int

isAdmMessagingRegistrationEnabled

val isAdmMessagingRegistrationEnabled: Boolean

isAutomaticGeofenceRequestsEnabled

val isAutomaticGeofenceRequestsEnabled: Boolean

isContentCardsUnreadVisualIndicatorEnabled

val isContentCardsUnreadVisualIndicatorEnabled: Boolean

Gets whether the Content Cards unread visual indication bar is enabled.

isDeviceObjectAllowlistEnabled

val isDeviceObjectAllowlistEnabled: Boolean

isDeviceObjectWhitelistEnabled

val isDeviceObjectWhitelistEnabled: Boolean

isEphemeralEventsEnabled

val isEphemeralEventsEnabled: Boolean

isFirebaseCloudMessagingRegistrationEnabled

val isFirebaseCloudMessagingRegistrationEnabled: Boolean

Gets whether the SDK is configured to automatically register for Firebase Cloud Messaging.

isFirebaseMessagingServiceOnNewTokenRegistrationEnabled

val isFirebaseMessagingServiceOnNewTokenRegistrationEnabled: Boolean

Determines whether the Braze will automatically register tokens in com.google.firebase.messaging.FirebaseMessagingService.onNewToken.

isGeofencesEnabled

val isGeofencesEnabled: Boolean

isHtmlInAppMessageApplyWindowInsetsEnabled

val isHtmlInAppMessageApplyWindowInsetsEnabled: Boolean

isInAppMessageAccessibilityExclusiveModeEnabled

val isInAppMessageAccessibilityExclusiveModeEnabled: Boolean

isInAppMessageTestPushEagerDisplayEnabled

val isInAppMessageTestPushEagerDisplayEnabled: Boolean

isLocationCollectionEnabled

val isLocationCollectionEnabled: Boolean

isNewsfeedVisualIndicatorOn

val isNewsfeedVisualIndicatorOn: Boolean

isPushDeepLinkBackStackActivityEnabled

val isPushDeepLinkBackStackActivityEnabled: Boolean

isPushNotificationHtmlRenderingEnabled

val isPushNotificationHtmlRenderingEnabled: Boolean

isPushWakeScreenForNotificationEnabled

val isPushWakeScreenForNotificationEnabled: Boolean

isSdkAuthenticationEnabled

val isSdkAuthenticationEnabled: Boolean

isSessionStartBasedTimeoutEnabled

val isSessionStartBasedTimeoutEnabled: Boolean

isTouchModeRequiredForHtmlInAppMessages

val isTouchModeRequiredForHtmlInAppMessages: Boolean

largeNotificationIconResourceId

val largeNotificationIconResourceId: Int

loggerInitialLogLevel

val loggerInitialLogLevel: Int

Gets the value for the initial log level. Note that this method defaults to Log.INFO. Should only be used in conjunction with BrazeLogger.

pushDeepLinkBackStackActivityClassName

val pushDeepLinkBackStackActivityClassName: String?

runtimeAppConfigurationProvider

var runtimeAppConfigurationProvider: RuntimeAppConfigurationProvider

sdkFlavor

val sdkFlavor: SdkFlavor?

sdkMetadata

val sdkMetadata: EnumSet<BrazeSdkMetadata>

Retrieves and aggregates all sources of SDK Metadata set on the SDK. Note that caches are skipped in the retrieval since some metadata can be set on the live SDK.

sessionTimeoutSeconds

val sessionTimeoutSeconds: Int

smallNotificationIconResourceId

val smallNotificationIconResourceId: Int

triggerActionMinimumTimeIntervalInSeconds

val triggerActionMinimumTimeIntervalInSeconds: Long

versionCode

val versionCode: Int