com.appboy.configuration

Class AppboyConfigurationProvider

java.lang.Object

com.appboy.configuration.CachedConfigurationProvider

com.appboy.configuration.AppboyConfigurationProvider

Direct Known Subclasses:

BrazeConfigurationProvider

Deprecated.

@Deprecated
public class AppboyConfigurationProvider
extends 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ADM_MESSAGING_REGISTRATION_ENABLED_KEY Deprecated.
protected static java.lang.String	API_KEY Deprecated.
protected static java.lang.String	APPLICATION_ICON_KEY Deprecated.
protected static java.lang.String	CONTENT_CARDS_UNREAD_VISUAL_INDICATOR_ENABLED Deprecated.
protected static java.lang.String	CUSTOM_ENDPOINT Deprecated.
protected static java.lang.String	CUSTOM_HTML_WEBVIEW_ACTIVITY_CLASS_NAME_KEY Deprecated.
protected static java.lang.String	CUSTOM_LOCATION_PROVIDERS_LIST_KEY Deprecated.
protected static java.lang.String	DEFAULT_NOTIFICATION_ACCENT_COLOR_KEY Deprecated.
protected static java.lang.String	DEFAULT_NOTIFICATION_CHANNEL_DESCRIPTION Deprecated.
protected static java.lang.String	DEFAULT_NOTIFICATION_CHANNEL_NAME Deprecated.
protected static java.lang.String	DEVICE_OBJECT_ALLOWLIST_VALUE Deprecated. Integrations using this value in braze.xml aren't expected so this field remains the old value.
protected static java.lang.String	DEVICE_OBJECT_ALLOWLISTING_ENABLED_KEY Deprecated. Integrations using this value in braze.xml aren't expected so this field remains the old value.
protected static java.lang.String	ENABLE_LOCATION_COLLECTION_KEY Deprecated.
protected static java.lang.String	FIREBASE_CLOUD_MESSAGING_REGISTRATION_ENABLED_KEY Deprecated.
protected static java.lang.String	FIREBASE_CLOUD_MESSAGING_SENDER_ID_KEY Deprecated.
protected static java.lang.String	FIREBASE_MESSAGING_SERVICE_AUTOMATICALLY_REGISTER_ON_NEW_TOKEN_KEY Deprecated.
protected static java.lang.String	GEOFENCES_AUTOMATIC_REQUESTS_ENABLED_KEY Deprecated.
protected static java.lang.String	GEOFENCES_ENABLED Deprecated.
protected static java.lang.String	HANDLE_PUSH_DEEP_LINKS_AUTOMATICALLY Deprecated.
protected static java.lang.String	IN_APP_MESSAGE_ACCESSIBILITY_EXCLUSIVE_MODE_ENABLED Deprecated.
protected static java.lang.String	IN_APP_MESSAGE_PUSH_TEST_EAGER_DISPLAY Deprecated.
protected static java.lang.String	IN_APP_MESSAGE_WEBVIEW_CLIENT_MAX_ONPAGEFINISHED_WAIT_KEY Deprecated.
protected static java.lang.String	LARGE_NOTIFICATION_ICON_KEY Deprecated.
protected static java.lang.String	LOCALE_TO_API_KEY_MAPPING_KEY Deprecated.
protected static java.lang.String	LOGGER_INITIAL_LOG_LEVEL Deprecated.
protected static java.lang.String	NEWSFEED_UNREAD_VISUAL_INDICATOR_ON Deprecated.
protected static java.lang.String	PUSH_DEEP_LINK_BACK_STACK_ACTIVITY_CLASS_NAME_KEY Deprecated.
protected static java.lang.String	PUSH_DEEP_LINK_BACK_STACK_ACTIVITY_ENABLED_KEY Deprecated.
protected static java.lang.String	PUSH_NOTIFICATION_HTML_RENDERING_ENABLED Deprecated.
protected static java.lang.String	PUSH_WAKE_SCREEN_FOR_NOTIFICATION_ENABLED Deprecated.
protected static java.lang.String	REQUIRE_TOUCH_MODE_FOR_HTML_IAMS_KEY Deprecated.
protected static java.lang.String	SDK_AUTH_ENABLED Deprecated.
protected static java.lang.String	SDK_FLAVOR Deprecated.
protected static java.lang.String	SERVER_TARGET_KEY Deprecated.
protected static java.lang.String	SESSION_START_BASED_TIMEOUT_ENABLED_KEY Deprecated.
protected static java.lang.String	SESSION_TIMEOUT_KEY Deprecated.
protected static java.lang.String	SMALL_NOTIFICATION_ICON_KEY Deprecated.
protected static java.lang.String	TRIGGER_ACTION_MINIMUM_TIME_INTERVAL_KEY_SECONDS Deprecated.
protected static java.lang.String	VERSION_CODE_KEY Deprecated.

Fields inherited from class com.appboy.configuration.CachedConfigurationProvider

mConfigurationCache, mRuntimeAppConfigurationProvider

Constructor Summary

Constructors

Constructor and Description
AppboyConfigurationProvider(android.content.Context context) Deprecated.

Method Summary

Modifier and Type	Method and Description
BrazeApiKey	getAppboyApiKey() Deprecated.
java.lang.String	getAppboyApiKeyStringFromLocaleMapping(java.util.Locale localeToMatch) Deprecated. Attempts to return the api key from the XML based on the current locale.
int	getApplicationIconResourceId() Deprecated.
java.lang.String	getBaseUrlForRequests() Deprecated.
java.lang.String	getCustomEndpoint() Deprecated.
java.lang.String	getCustomHtmlWebViewActivityClassName() Deprecated.
java.util.EnumSet<LocationProviderName>	getCustomLocationProviderNames() Deprecated.
int	getDefaultNotificationAccentColor() Deprecated.
java.lang.String	getDefaultNotificationChannelDescription() Deprecated.
java.lang.String	getDefaultNotificationChannelName() Deprecated.
java.util.EnumSet<DeviceKey>	getDeviceObjectAllowlist() Deprecated.
java.util.EnumSet<DeviceKey>	getDeviceObjectWhitelist() Deprecated. Use getDeviceObjectAllowlist()
java.lang.String	getFirebaseCloudMessagingSenderIdKey() Deprecated. Gets the sender ID key used to register for Firebase Cloud Messaging.
boolean	getHandlePushDeepLinksAutomatically() Deprecated.
int	getInAppMessageWebViewClientOnPageFinishedMaxWaitMs() Deprecated.
boolean	getIsAutomaticGeofenceRequestsEnabled() Deprecated.
boolean	getIsDeviceObjectAllowlistEnabled() Deprecated.
boolean	getIsDeviceObjectWhitelistEnabled() Deprecated. Use getIsDeviceObjectAllowlistEnabled()
boolean	getIsFirebaseMessagingServiceOnNewTokenRegistrationEnabled() Deprecated. Determines whether the Braze will automatically register tokens in com.google.firebase.messaging.FirebaseMessagingService#onNewToken(String).
boolean	getIsGeofencesEnabled() Deprecated.
boolean	getIsInAppMessageAccessibilityExclusiveModeEnabled() Deprecated.
boolean	getIsInAppMessageTestPushEagerDisplayEnabled() Deprecated.
boolean	getIsNewsfeedVisualIndicatorOn() Deprecated.
boolean	getIsPushDeepLinkBackStackActivityEnabled() Deprecated.
boolean	getIsPushNotificationHtmlRenderingEnabled() Deprecated.
boolean	getIsPushWakeScreenForNotificationEnabled() Deprecated.
boolean	getIsSdkAuthenticationEnabled() Deprecated.
boolean	getIsSessionStartBasedTimeoutEnabled() Deprecated.
boolean	getIsTouchModeRequiredForHtmlInAppMessages() Deprecated.
int	getLargeNotificationIconResourceId() Deprecated.
int	getLoggerInitialLogLevel() Deprecated. Gets the value for the initial log level.
java.lang.String	getPushDeepLinkBackStackActivityClassName() Deprecated.
SdkFlavor	getSdkFlavor() Deprecated.
int	getSessionTimeoutSeconds() Deprecated.
int	getSmallNotificationIconResourceId() Deprecated.
long	getTriggerActionMinimumTimeIntervalInSeconds() Deprecated.
int	getVersionCode() Deprecated.
boolean	isAdmMessagingRegistrationEnabled() Deprecated.
boolean	isContentCardsUnreadVisualIndicatorEnabled() Deprecated. Gets whether the Content Cards unread visual indication bar is enabled.
boolean	isFirebaseCloudMessagingRegistrationEnabled() Deprecated. Gets whether the SDK is configured to automatically register for Firebase Cloud Messaging.
boolean	isLocationCollectionEnabled() Deprecated.

Methods inherited from class com.appboy.configuration.CachedConfigurationProvider

getBooleanValue, getColorValue, getIntValue, getStringSetValue, getStringValue, readBooleanResourceValue, readColorResourceValue, readIntegerResourceValue, readStringArrayResourceValue, readStringResourceValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_KEY

protected static final java.lang.String API_KEY

Deprecated.

See Also:

Constant Field Values

SERVER_TARGET_KEY

protected static final java.lang.String SERVER_TARGET_KEY

Deprecated.

See Also:

Constant Field Values

ADM_MESSAGING_REGISTRATION_ENABLED_KEY

protected static final java.lang.String ADM_MESSAGING_REGISTRATION_ENABLED_KEY

Deprecated.

See Also:

Constant Field Values

SMALL_NOTIFICATION_ICON_KEY

protected static final java.lang.String SMALL_NOTIFICATION_ICON_KEY

Deprecated.

See Also:

Constant Field Values

LARGE_NOTIFICATION_ICON_KEY

protected static final java.lang.String LARGE_NOTIFICATION_ICON_KEY

Deprecated.

See Also:

Constant Field Values

VERSION_CODE_KEY

protected static final java.lang.String VERSION_CODE_KEY

Deprecated.

See Also:

Constant Field Values

APPLICATION_ICON_KEY

protected static final java.lang.String APPLICATION_ICON_KEY

Deprecated.

See Also:

Constant Field Values

SESSION_TIMEOUT_KEY

protected static final java.lang.String SESSION_TIMEOUT_KEY

Deprecated.

See Also:

Constant Field Values

LOCALE_TO_API_KEY_MAPPING_KEY

protected static final java.lang.String LOCALE_TO_API_KEY_MAPPING_KEY

Deprecated.

See Also:

Constant Field Values

ENABLE_LOCATION_COLLECTION_KEY

protected static final java.lang.String ENABLE_LOCATION_COLLECTION_KEY

Deprecated.

See Also:

Constant Field Values

DEFAULT_NOTIFICATION_ACCENT_COLOR_KEY

protected static final java.lang.String DEFAULT_NOTIFICATION_ACCENT_COLOR_KEY

Deprecated.

See Also:

Constant Field Values

TRIGGER_ACTION_MINIMUM_TIME_INTERVAL_KEY_SECONDS

protected static final java.lang.String TRIGGER_ACTION_MINIMUM_TIME_INTERVAL_KEY_SECONDS

Deprecated.

See Also:

Constant Field Values

HANDLE_PUSH_DEEP_LINKS_AUTOMATICALLY

protected static final java.lang.String HANDLE_PUSH_DEEP_LINKS_AUTOMATICALLY

Deprecated.

See Also:

Constant Field Values

NEWSFEED_UNREAD_VISUAL_INDICATOR_ON

protected static final java.lang.String NEWSFEED_UNREAD_VISUAL_INDICATOR_ON

Deprecated.

See Also:

Constant Field Values

SDK_FLAVOR

protected static final java.lang.String SDK_FLAVOR

Deprecated.

See Also:

Constant Field Values

CUSTOM_ENDPOINT

protected static final java.lang.String CUSTOM_ENDPOINT

Deprecated.

See Also:

Constant Field Values

DEFAULT_NOTIFICATION_CHANNEL_NAME

protected static final java.lang.String DEFAULT_NOTIFICATION_CHANNEL_NAME

Deprecated.

See Also:

Constant Field Values

DEFAULT_NOTIFICATION_CHANNEL_DESCRIPTION

protected static final java.lang.String DEFAULT_NOTIFICATION_CHANNEL_DESCRIPTION

Deprecated.

See Also:

Constant Field Values

PUSH_DEEP_LINK_BACK_STACK_ACTIVITY_ENABLED_KEY

protected static final java.lang.String PUSH_DEEP_LINK_BACK_STACK_ACTIVITY_ENABLED_KEY

Deprecated.

See Also:

Constant Field Values

PUSH_DEEP_LINK_BACK_STACK_ACTIVITY_CLASS_NAME_KEY

protected static final java.lang.String PUSH_DEEP_LINK_BACK_STACK_ACTIVITY_CLASS_NAME_KEY

Deprecated.

See Also:

Constant Field Values

SESSION_START_BASED_TIMEOUT_ENABLED_KEY

protected static final java.lang.String SESSION_START_BASED_TIMEOUT_ENABLED_KEY

Deprecated.

See Also:

Constant Field Values

FIREBASE_CLOUD_MESSAGING_REGISTRATION_ENABLED_KEY

protected static final java.lang.String FIREBASE_CLOUD_MESSAGING_REGISTRATION_ENABLED_KEY

Deprecated.

See Also:

Constant Field Values

FIREBASE_CLOUD_MESSAGING_SENDER_ID_KEY

protected static final java.lang.String FIREBASE_CLOUD_MESSAGING_SENDER_ID_KEY

Deprecated.

See Also:

Constant Field Values

CONTENT_CARDS_UNREAD_VISUAL_INDICATOR_ENABLED

protected static final java.lang.String CONTENT_CARDS_UNREAD_VISUAL_INDICATOR_ENABLED

Deprecated.

See Also:

Constant Field Values

DEVICE_OBJECT_ALLOWLISTING_ENABLED_KEY

protected static final java.lang.String DEVICE_OBJECT_ALLOWLISTING_ENABLED_KEY

Deprecated.

Integrations using this value in braze.xml aren't expected so this field remains the old value.

See Also:

Constant Field Values

DEVICE_OBJECT_ALLOWLIST_VALUE

protected static final java.lang.String DEVICE_OBJECT_ALLOWLIST_VALUE

Deprecated.

Integrations using this value in braze.xml aren't expected so this field remains the old value.

See Also:

Constant Field Values

IN_APP_MESSAGE_ACCESSIBILITY_EXCLUSIVE_MODE_ENABLED

protected static final java.lang.String IN_APP_MESSAGE_ACCESSIBILITY_EXCLUSIVE_MODE_ENABLED

Deprecated.

See Also:

Constant Field Values

PUSH_WAKE_SCREEN_FOR_NOTIFICATION_ENABLED

protected static final java.lang.String PUSH_WAKE_SCREEN_FOR_NOTIFICATION_ENABLED

Deprecated.

See Also:

Constant Field Values

PUSH_NOTIFICATION_HTML_RENDERING_ENABLED

protected static final java.lang.String PUSH_NOTIFICATION_HTML_RENDERING_ENABLED

Deprecated.

See Also:

Constant Field Values

GEOFENCES_ENABLED

protected static final java.lang.String GEOFENCES_ENABLED

Deprecated.

See Also:

Constant Field Values

IN_APP_MESSAGE_PUSH_TEST_EAGER_DISPLAY

protected static final java.lang.String IN_APP_MESSAGE_PUSH_TEST_EAGER_DISPLAY

Deprecated.

See Also:

Constant Field Values

LOGGER_INITIAL_LOG_LEVEL

protected static final java.lang.String LOGGER_INITIAL_LOG_LEVEL

Deprecated.

See Also:

Constant Field Values

CUSTOM_HTML_WEBVIEW_ACTIVITY_CLASS_NAME_KEY

protected static final java.lang.String CUSTOM_HTML_WEBVIEW_ACTIVITY_CLASS_NAME_KEY

Deprecated.

See Also:

Constant Field Values

GEOFENCES_AUTOMATIC_REQUESTS_ENABLED_KEY

protected static final java.lang.String GEOFENCES_AUTOMATIC_REQUESTS_ENABLED_KEY

Deprecated.

See Also:

Constant Field Values

CUSTOM_LOCATION_PROVIDERS_LIST_KEY

protected static final java.lang.String CUSTOM_LOCATION_PROVIDERS_LIST_KEY

Deprecated.

See Also:

Constant Field Values

IN_APP_MESSAGE_WEBVIEW_CLIENT_MAX_ONPAGEFINISHED_WAIT_KEY

protected static final java.lang.String IN_APP_MESSAGE_WEBVIEW_CLIENT_MAX_ONPAGEFINISHED_WAIT_KEY

Deprecated.

See Also:

Constant Field Values

FIREBASE_MESSAGING_SERVICE_AUTOMATICALLY_REGISTER_ON_NEW_TOKEN_KEY

protected static final java.lang.String FIREBASE_MESSAGING_SERVICE_AUTOMATICALLY_REGISTER_ON_NEW_TOKEN_KEY

Deprecated.

See Also:

Constant Field Values

SDK_AUTH_ENABLED

protected static final java.lang.String SDK_AUTH_ENABLED

Deprecated.

See Also:

Constant Field Values

REQUIRE_TOUCH_MODE_FOR_HTML_IAMS_KEY

protected static final java.lang.String REQUIRE_TOUCH_MODE_FOR_HTML_IAMS_KEY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AppboyConfigurationProvider

public AppboyConfigurationProvider(android.content.Context context)

Deprecated.

Method Detail

getBaseUrlForRequests

public java.lang.String getBaseUrlForRequests()

Deprecated.

getAppboyApiKeyStringFromLocaleMapping

public java.lang.String getAppboyApiKeyStringFromLocaleMapping(java.util.Locale localeToMatch)

Deprecated.

Attempts to return the api key from the XML based on the current locale. If the mapping is not present, returns null. If the mapping is present, but the current locale is not mapped, returns null.

This method expects locale -> apiKey string mappings in the form "LOCALE,API_KEY" and is delimited by a comma. If matched, the returned locale is trimmed.

Parameters:

localeToMatch - the Locale to associate the api key.

Returns:

api key based on the current locale, or null.

getAppboyApiKey

public BrazeApiKey getAppboyApiKey()

Deprecated.

Throws:

java.lang.RuntimeException - if the API key is not set

isAdmMessagingRegistrationEnabled

public boolean isAdmMessagingRegistrationEnabled()

Deprecated.

isLocationCollectionEnabled

public boolean isLocationCollectionEnabled()

Deprecated.

Returns:

true if Braze location collection is enabled in braze.xml, otherwise fallbacks to value of old configuration key com_appboy_disable_location_collection.

getIsGeofencesEnabled

public boolean getIsGeofencesEnabled()

Deprecated.

getSmallNotificationIconResourceId

public int getSmallNotificationIconResourceId()

Deprecated.

getLargeNotificationIconResourceId

public int getLargeNotificationIconResourceId()

Deprecated.

getTriggerActionMinimumTimeIntervalInSeconds

public long getTriggerActionMinimumTimeIntervalInSeconds()

Deprecated.

getSessionTimeoutSeconds

public int getSessionTimeoutSeconds()

Deprecated.

getVersionCode

public int getVersionCode()

Deprecated.

getCustomEndpoint

public java.lang.String getCustomEndpoint()

Deprecated.

getHandlePushDeepLinksAutomatically

public boolean getHandlePushDeepLinksAutomatically()

Deprecated.

getIsNewsfeedVisualIndicatorOn

public boolean getIsNewsfeedVisualIndicatorOn()

Deprecated.

getDefaultNotificationChannelName

public java.lang.String getDefaultNotificationChannelName()

Deprecated.

getDefaultNotificationChannelDescription

public java.lang.String getDefaultNotificationChannelDescription()

Deprecated.

getApplicationIconResourceId

public int getApplicationIconResourceId()

Deprecated.

getDefaultNotificationAccentColor

public int getDefaultNotificationAccentColor()

Deprecated.

getSdkFlavor

public SdkFlavor getSdkFlavor()

Deprecated.

getIsPushDeepLinkBackStackActivityEnabled

public boolean getIsPushDeepLinkBackStackActivityEnabled()

Deprecated.

getPushDeepLinkBackStackActivityClassName

public java.lang.String getPushDeepLinkBackStackActivityClassName()

Deprecated.

getIsSessionStartBasedTimeoutEnabled

public boolean getIsSessionStartBasedTimeoutEnabled()

Deprecated.

isFirebaseCloudMessagingRegistrationEnabled

public boolean isFirebaseCloudMessagingRegistrationEnabled()

Deprecated.

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

isContentCardsUnreadVisualIndicatorEnabled

public boolean isContentCardsUnreadVisualIndicatorEnabled()

Deprecated.

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

getFirebaseCloudMessagingSenderIdKey

public java.lang.String getFirebaseCloudMessagingSenderIdKey()

Deprecated.

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

getDeviceObjectWhitelist

@Deprecated
public java.util.EnumSet<DeviceKey> getDeviceObjectWhitelist()

Deprecated. Use getDeviceObjectAllowlist()

getDeviceObjectAllowlist

public java.util.EnumSet<DeviceKey> getDeviceObjectAllowlist()

Deprecated.

getIsDeviceObjectWhitelistEnabled

@Deprecated
public boolean getIsDeviceObjectWhitelistEnabled()

Deprecated. Use getIsDeviceObjectAllowlistEnabled()

getIsDeviceObjectAllowlistEnabled

public boolean getIsDeviceObjectAllowlistEnabled()

Deprecated.

getIsInAppMessageAccessibilityExclusiveModeEnabled

public boolean getIsInAppMessageAccessibilityExclusiveModeEnabled()

Deprecated.

getIsPushWakeScreenForNotificationEnabled

public boolean getIsPushWakeScreenForNotificationEnabled()

Deprecated.

getIsPushNotificationHtmlRenderingEnabled

public boolean getIsPushNotificationHtmlRenderingEnabled()

Deprecated.

getIsInAppMessageTestPushEagerDisplayEnabled

public boolean getIsInAppMessageTestPushEagerDisplayEnabled()

Deprecated.

getIsAutomaticGeofenceRequestsEnabled

public boolean getIsAutomaticGeofenceRequestsEnabled()

Deprecated.

getLoggerInitialLogLevel

public int getLoggerInitialLogLevel()

Deprecated.

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

getCustomHtmlWebViewActivityClassName

public java.lang.String getCustomHtmlWebViewActivityClassName()

Deprecated.

Returns:

A class name for a custom HTML WebView. Should be in the format as returned by Class.forName(String).

getInAppMessageWebViewClientOnPageFinishedMaxWaitMs

public int getInAppMessageWebViewClientOnPageFinishedMaxWaitMs()

Deprecated.

getCustomLocationProviderNames

public java.util.EnumSet<LocationProviderName> getCustomLocationProviderNames()

Deprecated.

getIsFirebaseMessagingServiceOnNewTokenRegistrationEnabled

public boolean getIsFirebaseMessagingServiceOnNewTokenRegistrationEnabled()

Deprecated.

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

Defaults to isFirebaseCloudMessagingRegistrationEnabled()

getIsSdkAuthenticationEnabled

public boolean getIsSdkAuthenticationEnabled()

Deprecated.

getIsTouchModeRequiredForHtmlInAppMessages

public boolean getIsTouchModeRequiredForHtmlInAppMessages()

Deprecated.