react-native-salesforce-dmp v1.0.0

react-native-salesforce-dmp

ReactNative module for Salesforce DMP 4.0.+ (KRUX)

Installation

npm install --save react-native-salesforce-dmp

react-native link react-native-salesforce-dmp

iOS

The krux library is embedded in this plugin, but make sure to check the official setup for extra information: here
Part of that setup is adding the following dependent frameworks to use the Salesforce DMP framework: SystemConfiguration.framework AdSupport.framework

Android

The krux library is embedded in this plugin, but make sure to check the official setup for extra information: here
Part of that setup is adding the following to the manifest:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<service android:name="com.krux.androidsdk.aggregator.EventPublisherService" android:enabled="true" />
<service android:name="com.krux.androidsdk.aggregator.ConsentService" android:enabled="true" /> 

Usage

// Import
import SalesforceDMP from 'react-native-salesforce-dmp';

Implemented calls:

/**
 * Setup tracker
 * @param {string} configId Configuration Id
 * @param {boolean} debugFlag This outputs debug messages while it is trying to fetch data/send data
 *     to Salesforce DMP backend servers. You should turn this off before the final submission of
 *     your app.
 * @return {promise}
 */
function setupTracker(configId, debugFlag) {
    return RNSalesforceDMPModule.setupTracker(configId, debugFlag = false);
}

/**
 * Get segments
 * @return {promise}
 */
function getSegments() {
    return RNSalesforceDMPModule.getSegments();
}

/**
* Track page view
* @param {string} section Section name
* @param {Object.<string, string>} pageAttributes An object with page attributes
* @param {Object.<string, string>} userAttributes An object with user attributes
* @return {promise}
*/
function trackPageView(section, pageAttributes = {}, userAttributes = {}) {
  return RNSalesforceDMPModule.trackPageView(section, pageAttributes, userAttributes);
}

/**
* Fire an event
* @param {string} event Event name
* @param {Object.<string, string>} attributes An object with event attributes
* @return {promise}
*/
function fireEvent(event, attributes = {}) {
  return RNSalesforceDMPModule.fireEvent(event, attributes);
}

/**
* Track a transaction
* @param {Object.<string, string>} attributes An object with transaction attributes
* @return {promise}
*/
function trackTransaction(attributes = {}) {
  return RNSalesforceDMPModule.trackTransaction(attributes);
}

/**
* Set consent
* @param {Object.<string, string>} attributes An object with attributes
* @return {promise}
*/
function consentSetRequest(attributes) {
  RNSalesforceDMPModule.consentSetRequest(attributes);
}

/**
* Get conset
* @param {Object.<string, string>} attributes An object with attributes
* @return {promise}
*/
function consentGetRequest(attributes) {
  RNSalesforceDMPModule.consentGetRequest(attributes);
}

/**
* Remove customer
* @param {Object.<string, string>} attributes An object with attributes
* @return {promise}
*/
function consumerRemoveRequest(attributes) {
  RNSalesforceDMPModule.consumerRemoveRequest(attributes);
}

/**
* Add consumer portability
* @param {Object.<string, string>} attributes An object with attributes
* @return {promise}
*/
function consumerPortabilityRequest(attributes) {
  RNSalesforceDMPModule.consumerPortabilityRequest(attributes);
}