Cordova SDK repository guide

About the Braze Cordova SDK

The Braze Cordova SDK helps you integrate Braze messaging, analytics, and user engagement capabilities into your application.

To get started, refer to the following resources:

• Braze User Guide
• Braze Developer Guide

Minimum version requirements

The following table lists the minimum supported versions for the Braze Cordova SDK.

This SDK also inherits the requirements of its underlying Braze native SDKs. Be sure to also adhere to version support information defined in braze-inc/braze-android-sdk and braze-inc/braze-swift-sdk.

Installing the SDK

important

Add the Braze Cordova SDK using only the following methods. Using other methods may introduce security risks.

1
2
3
4
5
6

# To use the base SDK functionality, install using the `master` branch.

cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#master

# To use location collection and geofences in addition to the base SDK functionality, install using `geofence-branch`.
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#geofence-branch

Running the sample application

1
2
3
4
5
6
7
8

cordova plugin remove cordova-plugin-braze
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#master

# To run android
cordova run android

# To run iOS
cordova run ios

For repository details and sample projects, see https://github.com/braze-inc/braze-cordova-sdk.