Skip to content

Customizing the Cordova Braze SDK

These are the available customizations for the Cordova Braze SDK.

Prerequisites

Before you start, you need to integrate the Cordova Braze SDK into your iOS or Android app.

Customization options

You can add any of the following preferences to the platform element in your project’s config.xml file:

Method Description
api_key Sets the API key for your application.
ios_api_endpoint Sets the SDK endpoint for your application.
ios_disable_automatic_push_registration Sets whether automatic push registration should be disabled.
ios_disable_automatic_push_handling Sets whether automatic push handling should be disabled.
ios_enable_idfa_automatic_collection Sets whether the Braze SDK should automatically collect the IDFA information. For more information, see Braze’s IDFA method documentation.
enable_location_collection Sets whether the automatic location collection is enabled (if the user permits). The geofence-branch
geofences_enabled Sets whether geofences are enabled.
ios_session_timeout Sets the Braze session timeout for your application in seconds. Defaults to 10 seconds.
sdk_authentication_enabled Sets whether to enable the SDK Authentication feature.
display_foreground_push_notifications Sets whether push notifications should be displayed while the application is in the foreground.
ios_disable_un_authorization_option_provisional Sets whether UNAuthorizationOptionProvisional should be disabled.
trigger_action_minimum_time_interval_seconds Sets the minimum time interval in seconds between triggers. Defaults to 30 seconds.
ios_push_app_group Sets the app group ID for iOS push extensions.
ios_forward_universal_links Sets if the SDK should automatically recognize and forward universal links to the system methods.
ios_log_level Sets the minimum logging level for Braze.Configuration.Logger.
ios_use_uuid_as_device_id Sets if a randomly generated UUID should be used as the device ID.
ios_flush_interval_seconds Sets the interval in seconds between automatic data flushes. Defaults to 10 seconds.
ios_use_automatic_request_policy Sets whether the request policy for Braze.Configuration.Api should be automatic or manual.
should_opt_in_when_push_authorized Sets if a user’s notification subscription state should automatically be set to optedIn when push permissions are authorized.
Method Description
api_key Sets the API key for your application.
android_api_endpoint Sets the SDK endpoint for your application.
android_small_notification_icon Sets the notification small icon.
android_large_notification_icon Sets the notification large icon.
android_notification_accent_color Sets the notification accent color using a hexadecimal representation.
android_default_session_timeout Sets the Braze session timeout for your application in seconds. Defaults to 10 seconds.
android_handle_push_deep_links_automatically Sets whether the Braze SDK should automatically handle push deep links.
android_log_level Sets the log level for your application. The default log level is 4 and will minimally log info. To enable verbose logging for debugging, use log level 2.
firebase_cloud_messaging_registration_enabled Sets whether to use Firebase Cloud Messaging for push notifications.
android_fcm_sender_id Sets the Firebase Cloud Messaging sender ID.
enable_location_collection Sets whether the automatic location collection is enabled (if the user permits).
geofences_enabled Sets whether geofences are enabled.
android_disable_auto_session_tracking Sets whether to disable the Android Cordova plugin from automatically tracking sessions.
sdk_authentication_enabled Sets whether to enable the SDK Authentication feature.
trigger_action_minimum_time_interval_seconds Sets the minimum time interval in seconds between triggers. Defaults to 30 seconds.
is_session_start_based_timeout_enabled Sets whether the session timeout behavior to be based either on session start or session end events.
default_notification_channel_name Sets the user-facing name as seen via NotificationChannel.getName for the Braze default NotificationChannel.
default_notification_channel_description Sets the user-facing description as seen via NotificationChannel.getDescription for the Braze default NotificationChannel.
does_push_story_dismiss_on_click Sets whether a Push Story is automatically dismissed when clicked.
is_fallback_firebase_messaging_service_enabled Sets whether the use of a fallback Firebase Cloud Messaging Service is enabled.
fallback_firebase_messaging_service_classpath Sets the classpath for the fallback Firebase Cloud Messaging Service.
is_content_cards_unread_visual_indicator_enabled Sets whether the Content Cards unread visual indication bar is enabled.
is_firebase_messaging_service_on_new_token_registration_enabled Sets whether the Braze SDK will automatically register tokens in com.google.firebase.messaging.FirebaseMessagingService.onNewToken.
is_push_deep_link_back_stack_activity_enabled Sets whether Braze will add an activity to the back stack when automatically following deep links for push.
push_deep_link_back_stack_activity_class_name Sets the activity that Braze will add to the back stack when automatically following deep links for push.
should_opt_in_when_push_authorized Sets if Braze should automatically opt-in the user when push is authorized.

The following is an example config.xml file with additional configurations:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<platform name="ios">
    <preference name="com.braze.ios_disable_automatic_push_registration" value="NO"/"YES" />
    <preference name="com.braze.ios_disable_automatic_push_handling" value="NO"/"YES" />
    <preference name="com.braze.ios_enable_idfa_automatic_collection" value="YES"/"NO" />
    <preference name="com.braze.enable_location_collection" value="NO"/"YES" />
    <preference name="com.braze.geofences_enabled" value="NO"/"YES" />
    <preference name="com.braze.ios_session_timeout" value="5" />
    <preference name="com.braze.sdk_authentication_enabled" value="YES"/"NO" />
    <preference name="com.braze.display_foreground_push_notifications" value="YES"/"NO" />
    <preference name="com.braze.ios_disable_un_authorization_option_provisional" value="NO"/"YES" />
    <preference name="com.braze.trigger_action_minimum_time_interval_seconds" value="30" />
    <preference name="com.braze.ios_push_app_group" value="PUSH_APP_GROUP_ID" />
    <preference name="com.braze.ios_forward_universal_links" value="YES"/"NO" />
    <preference name="com.braze.ios_log_level" value="2" />
    <preference name="com.braze.ios_use_uuid_as_device_id" value="YES"/"NO" />
    <preference name="com.braze.ios_flush_interval_seconds" value="10" />
    <preference name="com.braze.ios_use_automatic_request_policy" value="YES"/"NO" />
    <preference name="com.braze.should_opt_in_when_push_authorized" value="YES"/"NO" />
</platform>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

<platform name="android">
    <preference name="com.braze.android_small_notification_icon" value="RESOURCE_ENTRY_NAME_FOR_ICON_DRAWABLE" />
    <preference name="com.braze.android_large_notification_icon" value="RESOURCE_ENTRY_NAME_FOR_ICON_DRAWABLE" />
    <preference name="com.braze.android_notification_accent_color" value="str_ACCENT_COLOR_INTEGER" />
    <preference name="com.braze.android_default_session_timeout" value="str_SESSION_TIMEOUT_INTEGER" />
    <preference name="com.braze.android_handle_push_deep_links_automatically" value="true"/"false" />
    <preference name="com.braze.android_log_level" value="str_LOG_LEVEL_INTEGER" />
    <preference name="com.braze.firebase_cloud_messaging_registration_enabled" value="true"/"false" />
    <preference name="com.braze.android_fcm_sender_id" value="str_YOUR_FCM_SENDER_ID" />
    <preference name="com.braze.enable_location_collection" value="true"/"false" />
    <preference name="com.braze.geofences_enabled" value="true"/"false" />
    <preference name="com.braze.android_disable_auto_session_tracking" value="true"/"false" />
    <preference name="com.braze.sdk_authentication_enabled" value="true"/"false" />
    <preference name="com.braze.trigger_action_minimum_time_interval_seconds" value="str_MINIMUM_INTERVAL_INTEGER" />
    <preference name="com.braze.is_session_start_based_timeout_enabled" value="false"/"true" />
    <preference name="com.braze.default_notification_channel_name" value="DEFAULT_NAME" />
    <preference name="com.braze.default_notification_channel_description" value="DEFAULT_DESCRIPTION" />
    <preference name="com.braze.does_push_story_dismiss_on_click" value="true"/"false" />
    <preference name="com.braze.is_fallback_firebase_messaging_service_enabled" value="true"/"false" />
    <preference name="com.braze.fallback_firebase_messaging_service_classpath" value="FALLBACK_FIREBASE_MESSAGING_CLASSPATH" />
    <preference name="com.braze.is_content_cards_unread_visual_indicator_enabled" value="true"/"false" />
    <preference name="com.braze.is_firebase_messaging_service_on_new_token_registration_enabled" value="true"/"false" />
    <preference name="com.braze.is_push_deep_link_back_stack_activity_enabled" value="true"/"false" />
    <preference name="com.braze.push_deep_link_back_stack_activity_class_name" value="DEEPLINK_BACKSTACK_ACTIVITY_CLASS_NAME" />
    <preference name="com.braze.should_opt_in_when_push_authorized" value="true"/"false" />
</platform>

Platform-specific syntax

Integers

Integer preferences are read as string representations, like in the following example:

1
2
3
4

<platform name="ios">
    <preference name="com.braze.ios_flush_interval_seconds" value="10" />
    <preference name="com.braze.ios_session_timeout" value="5" />
</platform>

Due to how the Cordova 8.0.0+ framework handles preferences, integer-only preferences (such as sender IDs) must be set to strings prepended with str_, like in the following example:

1
2
3
4

<platform name="android">
    <preference name="com.braze.android_fcm_sender_id" value="str_64422926741" />
    <preference name="com.braze.android_default_session_timeout" value="str_10" />
</platform>

Booleans

Boolean preferences are read by the SDK using YES and NO keywords as a string representation, like in the following example:

1
2
3
4

<platform name="ios">
    <preference name="com.braze.should_opt_in_when_push_authorized" value="YES" />
    <preference name="com.braze.ios_disable_automatic_push_handling" value="NO" />
</platform>

Boolean preferences are read by the SDK using true and false keywords as a string representation, like in the following example:

1
2
3
4

<platform name="android">
    <preference name="com.braze.should_opt_in_when_push_authorized" value="true" />
    <preference name="com.braze.is_session_start_based_timeout_enabled" value="false" />
</platform>
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!