@deltax-sdk/cordova-plugin-deltax-mobile-sdk v1.0.1

cordova-plugin-deltax-mobile-sdk

Description

Cordova-plugin-deltax-mobile-sdk is a cordova plugin which allows you to use the DeltaX Mobile SDK in your cordova-based hybrid applications. The support is currently limited to the android platform.

Usage

Get access to plugin:

Plugin will be available in window object once cordova is initialised. You can listen to document ready event and initialise the plugin. In Ionic, you can access it after platform ready.

https://ionicframework.com/docs/utilities/platform#ready-promise-string-

var dxPlugin = {};

if(window && window.DeltaXMobileSDK){

    dxPlugin = window.DeltaXMobileSDK;

}

Note: You need to maintain this dxPlugin object. Alternatively, you can skip this step and access the sdk using window.DeltaXMobileSDK. Example: window.DeltaXMobileSDK.initDxTracker('xxxx1234');

Initialise SDK:

	initDxTracker(businessProfileEncodedIds, success, failure)

Example:

dxPlugin.initDxTracker( ['xxxx1234', 'xxxx6789'] ,

					    ( ) => {
					    
					    //Statements to execute on success
					    
					    },
					    
					    ( ) => {
					    
					    //Statements to execute on failure
					    
					    }
); 

Note: The first BusinessProfileEncodedId in the first call to initDxTracker is set as the default tracker by the SDK. If you wish to change the default tracker, setDefaultTracker must be called explicitly.

Set Default Tracker Instance:

setDefaultTracker(businessProfileEncodedId, success, failure)

Example:

dxPlugin.setDefaultTracker( 'xxxx6789'); 

Set Default Customer Id:

Note: This value can be overridden when you're tracking a particular event.

setCustomerId(params, success, failure)

params

Example:

// Specify business profile for which property is to be set

var params = {

    Value: '123',
    
    BusinessProfileEncodedId: 'xxxx1234'

};

dxPlugin.setCustomerId(params); 

// Apply property for default tracker

var params = {
    Value: '123'
};

dxPlugin.setCustomerId(params); 

Set Default Customer Phone Number and Default Customer Email:

Note: These values can be overridden when you're tracking a particular event.

setCustomerPhoneNumber(params, success, failure)

setCustomerEmail(params, success, failure)

params

// Specify business profile for which property is to be set
// Since IsEncoded is not passed in params, SDK will encode it

var params = {
    Value: 'abcd@xyz.com',
    BusinessProfileEncodedId: 'xxxx1234'
};

dxPlugin.setCustomerEmail(params);

  

// Since IsEncoded is set to true, SDK expects encoded value to be passed

var params = {
    Value: '52baew13c1',
    IsEncoded: true,    
    BusinessProfileEncodedId: 'xxxx1234'    
};

dxPlugin.setCustomerPhoneNumber(params); 

Track event:

trackEvent(params, success, failure)

params

Note: Setting values for CustomerId/CustomerMail/CustomerPhone will override the default value for the particular tracker for this particular event.

Example:

// If default customer properties (Id, Phone Number, Email) have been set for the tracker 'xxxx1234', they will also be part of the event

var params = {
    BusinessProfileEncodedId: 'xxxx1234',  
    GoalId : '6AMDX4',    
    Quantity : '1'    
};

dxPlugin.trackEvent(params); 

// Since BusinessProfileEncodedId is not passed in params, default tracker instance will be used.

var params = {
    GoalId : '6AMDX4',
    Quantity : '1'
};

dxPlugin.trackEvent(params); 

Track deep links:

trackClick(params, success, failure)

params

Example:

var params = {
    BusinessProfileEncodedId: 'xxxx1234',
    Uri: 'https://www.mytestdomain.com/test/123'
};

dxPlugin.trackClick(params);

Disable tracking:

disableTracking(success,failure)

Example:

dxPlugin.disableTracking();

Enable tracking:

enableTracking(success,failure)

Example:

dxPlugin.enableTracking();