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

BrazeConfig

class BrazeConfig(val builder: BrazeConfig.Builder)

Immutable configuration object for the Braze SDK. Build one using BrazeConfig.Builder and pass it to Braze.configure.

Constructors

private constructor(builder: BrazeConfig.Builder)

Types

class Builder(var apiKey: String? = null, var serverTarget: String? = null, var smallNotificationIconName: String? = null, var largeNotificationIconName: String? = null, var customEndpoint: String? = null, var defaultNotificationChannelName: String? = null, var defaultNotificationChannelDescription: String? = null, var pushDeepLinkBackStackActivityClassName: String? = null, var firebaseCloudMessagingSenderIdKey: String? = null, var customHtmlWebViewActivityClassName: String? = null, var sdkFlavor: SdkFlavor? = null, var sessionTimeout: Int? = null, var defaultNotificationAccentColor: Int? = null, var triggerActionMinimumTimeIntervalSeconds: Int? = null, var badNetworkInterval: Int? = null, var goodNetworkInterval: Int? = null, var greatNetworkInterval: Int? = null, var inAppMessageWebViewClientMaxOnPageFinishedWaitMs: Int? = null, var admMessagingRegistrationEnabled: Boolean? = null, var handlePushDeepLinksAutomatically: Boolean? = null, var isAutomaticLocationCollectionEnabled: Boolean? = null, var isPushDeepLinkBackStackActivityEnabled: Boolean? = null, var isSessionStartBasedTimeoutEnabled: Boolean? = null, var isFirebaseCloudMessagingRegistrationEnabled: Boolean? = null, var isContentCardsUnreadVisualIndicatorEnabled: Boolean? = null, var isInAppMessageAccessibilityExclusiveModeEnabled: Boolean? = null, var isPushWakeScreenForNotificationEnabled: Boolean? = null, var isPushHtmlRenderingEnabled: Boolean? = null, var isGeofencesEnabled: Boolean? = null, var inAppMessageTestPushEagerDisplayEnabled: Boolean? = null, var automaticGeofenceRequestsEnabled: Boolean? = null, var isFirebaseMessagingServiceOnNewTokenRegistrationEnabled: Boolean? = null, var isTouchModeRequiredForHtmlInAppMessages: Boolean? = null, var isSdkAuthEnabled: Boolean? = null, var deviceObjectAllowlist: EnumSet<DeviceKey>? = null, var isDeviceObjectAllowlistEnabled: Boolean? = null, var brazeSdkMetadata: EnumSet<BrazeSdkMetadata>? = null, var customLocationProviderNames: EnumSet<LocationProviderName>? = null, var isHtmlInAppMessageApplyWindowInsetsEnabled: Boolean? = null, var isHtmlInAppMessageHtmlLinkTargetEnabled: Boolean? = null, var doesPushStoryDismissOnClick: Boolean? = null, var isFallbackFirebaseMessagingServiceEnabled: Boolean? = null, var fallbackFirebaseMessagingServiceClasspath: String? = null, var shouldOptInWhenPushAuthorized: Boolean? = null, var shouldUseWindowFlagSecureInActivities: Boolean? = null, var shouldPersistWebViewWhenBackgroundingApp: Boolean? = null, var shouldAddStatusBarPaddingToInAppMessages: Boolean? = null)

Builder for constructing a BrazeConfig instance.

Properties

val apiKey: String?

areAutomaticGeofenceRequestsEnabled

val areAutomaticGeofenceRequestsEnabled: Boolean?

areGeofencesEnabled

val areGeofencesEnabled: Boolean?

badNetworkInterval

val badNetworkInterval: Int?

brazeSdkMetadata

val brazeSdkMetadata: EnumSet<BrazeSdkMetadata>?

private val builder: BrazeConfig.Builder

val customEndpoint: String?

customHtmlWebViewActivityClassName

val customHtmlWebViewActivityClassName: String?

customLocationProviderNames

val customLocationProviderNames: EnumSet<LocationProviderName>?

defaultNotificationAccentColor

val defaultNotificationAccentColor: Int?

defaultNotificationChannelDescription

val defaultNotificationChannelDescription: String?

defaultNotificationChannelName

val defaultNotificationChannelName: String?

deviceObjectAllowlist

val deviceObjectAllowlist: EnumSet<DeviceKey>?

doesPushStoryDismissOnClick

val doesPushStoryDismissOnClick: Boolean?

fallbackFirebaseMessagingServiceClasspath

val fallbackFirebaseMessagingServiceClasspath: String?

firebaseCloudMessagingSenderIdKey

val firebaseCloudMessagingSenderIdKey: String?

goodNetworkInterval

val goodNetworkInterval: Int?

greatNetworkInterval

val greatNetworkInterval: Int?

inAppMessageWebViewClientMaxOnPageFinishedWaitMs

val inAppMessageWebViewClientMaxOnPageFinishedWaitMs: Int?

isAdmMessagingRegistrationEnabled

val isAdmMessagingRegistrationEnabled: Boolean?

isAutomaticLocationCollectionEnabled

val isAutomaticLocationCollectionEnabled: Boolean?

isContentCardsUnreadVisualIndicatorEnabled

val isContentCardsUnreadVisualIndicatorEnabled: Boolean?

isDeviceObjectAllowlistEnabled

val isDeviceObjectAllowlistEnabled: Boolean?

isFallbackFirebaseMessagingServiceEnabled

val isFallbackFirebaseMessagingServiceEnabled: Boolean?

isFirebaseCloudMessagingRegistrationEnabled

val isFirebaseCloudMessagingRegistrationEnabled: Boolean?

isFirebaseMessagingServiceOnNewTokenRegistrationEnabled

val isFirebaseMessagingServiceOnNewTokenRegistrationEnabled: Boolean?

isHtmlInAppMessageApplyWindowInsetsEnabled

val isHtmlInAppMessageApplyWindowInsetsEnabled: Boolean?

isHtmlInAppMessageHtmlLinkTargetEnabled

val isHtmlInAppMessageHtmlLinkTargetEnabled: Boolean?

isInAppMessageAccessibilityExclusiveModeEnabled

val isInAppMessageAccessibilityExclusiveModeEnabled: Boolean?

isInAppMessageTestPushEagerDisplayEnabled

val isInAppMessageTestPushEagerDisplayEnabled: Boolean?

isPushDeepLinkBackStackActivityEnabled

val isPushDeepLinkBackStackActivityEnabled: Boolean?

isPushHtmlRenderingEnabled

val isPushHtmlRenderingEnabled: Boolean?

isPushWakeScreenForNotificationEnabled

val isPushWakeScreenForNotificationEnabled: Boolean?

isSdkAuthEnabled

val isSdkAuthEnabled: Boolean?

isSessionStartBasedTimeoutEnabled

val isSessionStartBasedTimeoutEnabled: Boolean?

isTouchModeRequiredForHtmlInAppMessages

val isTouchModeRequiredForHtmlInAppMessages: Boolean?

largeNotificationIcon

val largeNotificationIcon: String?

pushDeepLinkBackStackActivityClassName

val pushDeepLinkBackStackActivityClassName: String?

val sdkFlavor: SdkFlavor?

val serverTarget: String?

val sessionTimeout: Int?

shouldAddStatusBarPaddingToInAppMessages

val shouldAddStatusBarPaddingToInAppMessages: Boolean?

shouldOptInWhenPushAuthorized

val shouldOptInWhenPushAuthorized: Boolean?

shouldPersistWebViewWhenBackgroundingApp

val shouldPersistWebViewWhenBackgroundingApp: Boolean?

shouldUseWindowFlagSecureInActivities

val shouldUseWindowFlagSecureInActivities: Boolean?

smallNotificationIcon

val smallNotificationIcon: String?

triggerActionMinimumTimeIntervalSeconds

val triggerActionMinimumTimeIntervalSeconds: Int?

willHandlePushDeepLinksAutomatically

val willHandlePushDeepLinksAutomatically: Boolean?

Functions

open override fun toString(): String