Use this plugin to implement the Marketing Cloud MobilePush SDK for your iOS and Android applications.
Release notes for the plugin can be found here
1. Add plugin to your application via npm
cordova plugin add cordova-plugin-marketingcloudsdk<!-- Required -->
<preference name="com.salesforce.marketingcloud.app_id" value="{Marketing Cloud application id}" />
<preference name="com.salesforce.marketingcloud.access_token" value="{Marketing Cloud access token}" />
<!-- Required - Android Only -->
<platform name="android">
<preference name="com.salesforce.marketingcloud.notification_small_icon" value="ic_notification" />
</platform>
<!-- Optional - Will soon be required -->
<preference name="com.salesforce.marketingcloud.tenant_specific_endpoint" value="{URL retrieved from Marketing Cloud adminstration page}" />
<!-- Optional -->
<preference name="com.salesforce.marketingcloud.analytics" value="{true|false}" />To enable push support for the Android platform you will need to include the google-services.json file.
- Download the file from your application's Firebase console and place it in your project's root folder.
- Add following to Android element in your
config.xml:
<platform name="android">
<resource-file src="google-services.json" target="app/google-services.json" />
</platform>- MCCordovaPlugin
- .isPushEnabled(successCallback, [errorCallback])
- .enablePush([successCallback], [errorCallback])
- .disablePush([successCallback], [errorCallback])
- .getSystemToken(successCallback, [errorCallback])
- .getAttributes(successCallback, [errorCallback])
- .setAttribute(key, value, [successCallback], [errorCallback])
- .clearAttribute(key, [successCallback], [errorCallback])
- .addTag(tag, [successCallback], [errorCallback])
- .removeTag(tag, [successCallback], [errorCallback])
- .getTags(successCallback, [errorCallback])
- .setContactKey(contactKey, [successCallback], [errorCallback])
- .getContactKey(successCallback, [errorCallback])
- .enableVerboseLogging([successCallback], [errorCallback])
- .disableVerboseLogging([successCallback], [errorCallback])
The current state of the pushEnabled flag in the native Marketing Cloud SDK.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| successCallback | function |
|
| successCallback.enabled | boolean |
Whether push is enabled. |
| [errorCallback] | function |
Enables push messaging in the native Marketing Cloud SDK.
Kind: static method of MCCordovaPlugin
See
| Param | Type |
|---|---|
| [successCallback] | function |
| [errorCallback] | function |
Disables push messaging in the native Marketing Cloud SDK.
Kind: static method of MCCordovaPlugin
See
| Param | Type |
|---|---|
| [successCallback] | function |
| [errorCallback] | function |
Returns the token used by the Marketing Cloud to send push messages to the device.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| successCallback | function |
|
| successCallback.token | string |
The token used for push messaging. |
| [errorCallback] | function |
Returns the maps of attributes set in the registration.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| successCallback | function |
|
| successCallback.attributes | Object.<string, string> |
The key/value map of attributes set in the registration. |
| [errorCallback] | function |
Sets the value of an attribute in the registration.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| key | string |
The name of the attribute to be set in the registration. |
| value | string |
The value of the key attribute to be set in the registration. |
| [successCallback] | function |
|
| successCallback.saved | boolean |
Whether the attribute value was set in the registration. |
| [errorCallback] | function |
Clears the value of an attribute in the registration.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| key | string |
The name of the attribute whose value should be cleared from the registration. |
| [successCallback] | function |
|
| successCallback.saved | boolean |
Whether the value of the key attribute was cleared from the registration. |
| [errorCallback] | function |
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| tag | string |
The tag to be added to the list of tags in the registration. |
| [successCallback] | function |
|
| successCallback.saved | boolean |
Whether the value passed in for tag was saved in the registration. |
| [errorCallback] | function |
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| tag | string |
The tag to be removed from the list of tags in the registration. |
| [successCallback] | function |
|
| successCallback.saved | boolean |
Whether the value passed in for tag was cleared from the registration. |
| [errorCallback] | function |
Returns the tags currently set on the device.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| successCallback | function |
|
| successCallback.tags | Array.<string> |
The array of tags currently set in the native SDK. |
| [errorCallback] | function |
Sets the contact key for the device's user.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| contactKey | string |
The value to be set as the contact key of the device's user. |
| [successCallback] | function |
|
| successCallback.saved | boolean |
Whether the value passed in for contactKey was saved in the registration. |
| [errorCallback] | function |
Returns the contact key currently set on the device.
Kind: static method of MCCordovaPlugin
See
| Param | Type | Description |
|---|---|---|
| successCallback | function |
|
| successCallback.contactKey | string |
The current contact key. |
| [errorCallback] | function |
Enables verbose logging within the native Marketing Cloud SDK.
Kind: static method of MCCordovaPlugin
See
| Param | Type |
|---|---|
| [successCallback] | function |
| [errorCallback] | function |
Disables verbose logging within the native Marketing Cloud SDK.
Kind: static method of MCCordovaPlugin
See
| Param | Type |
|---|---|
| [successCallback] | function |
| [errorCallback] | function |