Swrve is a single integrated platform delivering everything you need to drive mobile engagement and create valuable consumer relationships on mobile. This Cordova plugin will enable your app to use all of these features on Android and iOS.
We recommend you read our integration guide before attempting to download and add to the sourcecode yourself.
The SDK uses Cordova hooks which allow us to modify the generated code as part of the plugin installation to the platform.
We currently use the after_plugin_install and after_prepare hook to include the native changes needed to kick off the Swrve Native SDK side of the Plugin.
If you are starting with a fresh application, there is a template available which we recommend using.
This can be added with the following command replacing hello, com.example.hello and HelloWorld with your own desired attributes:
cordova create hello com.example.hello HelloWorld --template https://github.com/Swrve/swrve-cordova-minimal-integration.gitOur SDK uses a series of hooks to inject code to the final iOS/Android project. Below, we provide a table with all available preferences the SwrveSDK can interpret.
| Preference | Description | type |
|---|---|---|
swrve.appId |
Swrve App Id | string |
swrve.apiKey |
Swrve API Key | string |
swrve.pushEnabled |
Include and enable push notifications. | boolean |
swrve.adJourneyEnabled |
Include and enable ad journey support. | boolean |
| Preference | Description | type |
|---|---|---|
swrve.handlingGoogleServices |
Set true if you are handling your own Google Services setup and don't want Swrve to alter anything associated with it. This will also make sure that the SwrveFirebaseMessagingService is not added and will require you to forward the Firebase message to Swrve. Contact a CSM for more details. | boolean |
swrve.drawablePath |
Local path that points to your icon files that are used for Android push notifications. | string |
swrve.googleServicesPath |
Path for your local google-services.json file that is required to use Android push notifications. | string |
GradlePluginGoogleServicesEnabled |
This is a cordova preference added in cordova-android-9.0.0 that is required to be true for Android push notifications. | boolean |
swrve.pushNotificationPermissionEvent |
Event that triggers the push notification permission request. It will not trigger at startup automatically. | string |
| Preference | Description | type |
|---|---|---|
swrve.appGroupIdentifier |
This is an application group identifier that is used for push notification influence tracking. | string |
swrve.clearPushBadgeOnStartup |
When enabled, the application clears any notification badges from the app icon when the app starts. | boolean |
swrve.pushNotificationEvent |
Event that triggers the push notification permission request. Include if you do not want to ask for push permissions on startup. | string |
swrve.provisionalPushNotificationEvent |
Event that triggers token retrieval for provisional push notifications. | string |
We have provided tests inside the /tests directory contains cordova project which verifies the connection between Swrve Native SDKs for iOS and Android and our Cordova Plugin along with tests for our hook system.
These have complete projects included so you can simply open them and run them without using any cordova commands.
We would love to see your contributions! Follow these steps:
- Fork this repository.
- Create a branch (
git checkout -b my_awesome_cordova_feature) - Commit your changes (
git commit -m "Awesome Cordova feature") - Push to the branch (
git push origin my_awesome_cordova_feature) - Open a Pull Request.
© Copyright Swrve Mobile Inc or its licensors. Distributed under the Apache 2.0 License.