Implement the plugin

Call this method as soon as possible in your app initialization process to register the device and receive a push.
The method must be called on every app launch.
Notification methods (pushMessageReceived, richMessageReceived) are only available after this method is called.
@param {string} sdkID - The SDK ID for your account.
@param {string} appSecret - The App Secret for your account.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.

MappPlugin.prototype.engage = function (sdkID, appSecret, successCallback, errorCallback) {}

...

...

Implement the plugin

Call this method as soon as possible in your app initialization process to register the device and receive a push.
The method must be called on every app launch.
Notification methods (pushMessageReceived, richMessageReceived) are only available after this method is called.
@param {string} sdkID - The SDK ID for your account.
@param {string} googleProjectID - The Google project id from your Firebase console for the chosen app.
@param {string} server - The Server, which will be use for engagement, this info will be provided by account managers.
@param {string} tenantID - The ID which recognise you at the Mapp Engage system, will be also provided by account managers.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.

MappPlugin.prototype.engage = function (sdkID, appSecret, successCallback, errorCallback) {}

function engage() {
    if (device.platform == "iOS") {

        // No need to engage.
        // Engaging is performed under the hood, by supplying the AppoxeeConfig.plist file.

    } else {

        MappPlugin.engage("sdkKeysdkID",
            "googleProjectID",
            "googleProjectIdserver",
            "appID",
            "cepURLtenantID",
            function (json) {
          "appID",          alert(JSON.stringify(json)); 
              "tenantID",
         },
               function (json) {
        
                alert(JSON.stringify(json)); 
            });

      }
   },
                         function (json) {
                         alert(JSON.stringify(json));
    }

Check if the device is registered in Mapp

Returns "true" if registration is completed, "false" if failed or not yet completed.
MappPlugin.prototype.isReady = function (successCallback, errorCallback)

Alias

Set device alias

@param {string} alias - A string to be identified as the device alias.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.setDeviceAlias = function (alias, successCallback, errorCallback) {}

 function setDeviceAlias() {
    
    MappPlugin.setDeviceAlias("Phonegap Alias",
             });
} 

Check if the device is registered in Mapp

Returns "true" if registration is completed, "false" if failed or not yet completed.
MappPlugin.prototype.isReady = function (successCallback, errorCallback)

Alias

Set device alias

@param {string} alias - A string to be identified as the device alias.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.setDeviceAlias = function (alias, successCallback, errorCallback) {}

 function setDeviceAlias() {                    function (json) {
                                 MappPluginalert(JSON.setDeviceAlias("Phonegap Alias",stringify(json));
                                 },
function (json) {                               function   alert(JSON.stringify(json));
                                 },
                                 function (json) (json) {
                                 alert(JSON.stringify(json));
                                 });
}

...

@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.getAlias = function (successCallback, errorCallback) {}

...

Remove the alias associated with this device.
@callback {string} Empty string is need to be sent as an alias, because Engage system does not support NULL as an alias value. 
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.removeDeviceAlias = function (successCallback, errorCallback) {}

 function removeDeviceAlias() {
    
    MappPlugin.removeDeviceAlias("", function (json) {
                       
            alert(JSON.stringify(json));
        },
        function (json) {
            alert(JSON.stringify(json));
   },                 });
}

Device API 

Device Information

Get information associated with this device.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.deviceInformation = function (successCallback, errorCallback) {}

 function deviceInformation() {
    
              MappPlugin.deviceInformation(function (json) {
                                    alert(JSON.stringify(json));
                                    });
}

Device API 

Device Information

Get information associated with this device.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.deviceInformation = function (successCallback, errorCallback) {}

 function deviceInformation() {,
             MappPlugin.deviceInformation(function (json) {                                     alert(JSON.stringifyfunction (json)); {
                                   },
                                    function  alert(JSON.stringify(json));
{                                     alert(JSON.stringify(json));
                                    });
}

Get Rich Messages

});
}

Get Rich Messages

Get rich messages for this device.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.getRichMessages = function (successCallback, errorCallback) {}

...

Delete a Rich Message.
@param {string} msgID - A string representing the message ID. Message ID's can be retrieved in MappPlugin.refreshInbox()
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.deleteRichMessage = function (msgID, successCallback, errorCallback) {}

...

Sync inbox messages with Mapp servers.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.refreshInbox = function (successCallback, errorCallback) {}

...

Check if the feature is enabled.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.isPushEnabled = function (successCallback, errorCallback) {}

...

Method will disable / enable the feature.
@param {string} disable - a string with a value of "true" or "false".
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.disablePushNotifications = function (disable, successCallback, errorCallback) {}

 function disablePushNotifications() {
    
    MappPlugin.disablePushNotifications("true",
                                           function (json) {
                                           alert(JSON.stringify(json));
                                           },
                                           function (json) {
                                           alert(JSON.stringify(json));
                                           });
}

Custom Fields API

Set Date Field

Set a date value for a key.
@param {string} key - A key to be paired with the value.
@param {string} value - A value which conforms 'yyyy-MM-dd hh:mm:ss'.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.setDateField = function (key, value, successCallback, errorCallback) {}

...

Set a number value for a key.
@param {string} key - A key to be paired with the value.
@param {string} value - A value which contains a number, i.e. "34", "34.54".
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.setNumericField = function (key, value, successCallback, errorCallback) {}

...

Set a string value for a key.
@param {string} key - A key to be paired with the value.
@param {string} value - A value which contains string.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.setStringField = function (key, value, successCallback, errorCallback) {}

...

Get a key-value pair for a given key.
@param {string} key - A key paired with a value.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.
MappPlugin.prototype.fetchCustomFieldByKey = function (key, successCallback, errorCallback) {}

...

MappPlugin.prototype.getLastPushPayload = function (successCallback, errorCallback) {}

function getLastPushPayload() {

	MappPlugin.getLastPushPayload(function (json) {
									alert(JSON.stringify(json));
									},
									function (json) {
									alert(JSON.stringify(json));
									});
}

Badge Number (iOS

...

only)

Method sets the application badge number on iOS only, and only if notifications are approved.
@param {string} badgeNumber - a string with a value of an Integer, to set as the application badge number.
@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.

MappPlugin.prototype.setApplicationBadgeNumber = function (badgeNumber, successCallback, errorCallback){}

...

MappPlugin.prototype.showNotificationsOnForeground = function (show, successCallback, errorCallback){}

...

Method is called when a rich message is received.
@param {string} jsonArg - A json string with the rich message payload.
MappPlugin.prototype.richMessageReceived = function richMessageReceived(jsonArg) {}

 MappPlugin.prototype.richMessageReceived = function richMessageReceived(jsonArg) {
      alert("Rich Message:\n" + jsonArg);
            
      /* Add your own implementation here. */ 
}

On Push Message Listener (Android Only)

There are 4 types of messages in messageHandlerType field onPushOpened, onPushDismissed, onSilentPush, onPushReceived 

* @callback {string} successCallback - A json string with a response for this operation with information.
* @callback {string} errorCallback - A json string with a response for this operation with information.

function setOnPushMessageListener() {


    MappPlugin.setOnPushMessageListener(
        function (json) {
            alert(JSON.stringify(json));
        },
        function (json) {
            alert(JSON.stringify(json));
        });
}

Show In-App message (iOS Only)

...

@param {string} appId - specific ID for the application.

@param{string} tenantId -  tenant ID for our system which is provided by our account management.

@param{string} userId - ID from our Engage system which is provided by our account management.

@param{string} deviceId - UDID from the device.

@param{string} jamieUrl - specific url that is also provided by our account management.

@param{string} alias -  A string to be identified as the device alias

@param{string} eventName - specific Engage event trigger.

@callback {string} successCallback - A json string with a response for this operation with information.
@callback {string} errorCallback - A json string with a response for this operation with information.

MappInappPlugin.prototype.fireInappEvent = function (appId, tenantId, userId, deviceId, jamieUrl, alias, eventName, successCallback, errorCallback){}

...

...

{}

 MappPlugin.prototype.richMessageReceived = function richMessageReceived(jsonArg) {
      alert("Rich Message:\n" + jsonArg);
           						 
  alert(JSON.stringify(json));    /*  							    });Add your own implementation here. */ 
}

Show In-App message (iOS Only)

Method to trigger an In-App message.

@param{string} name - string which describes the event name, Engage event trigger.

@param{string} attributes - a string which contains Plist objects with any additional data.

On Push Message Listener (Android Only)

There are 4 types of messages in messageHandlerType field onPushOpened, onPushDismissed, onSilentPush, onPushReceived 

* @callback {string} successCallback - A json string with a response for this operation with information.
* @callback {string} errorCallback - A json string with a response for this operation with information.MappInappPlugin.prototype.reportInteractionEventWithNameAndAttributes = function (name, attributes, successCallback, errorCallback){}

function reportInteractionEventWithNameAndAttributessetOnPushMessageListener() {


    MappInappPluginMappPlugin.reportInteractionEventWithNameAndAttributessetOnPushMessageListener("name",
																"attributes",
        															function (json) {
            														alert(JSON.stringify(json));
       																 },
        															function (json) {
            														alert(JSON.stringify(json));
        															});
}

Fetch inapp inbox messages(iOS only)

The method fetches all inbox In-App messages.

...

MappInappPlugin.prototype.fetchInboxMessages = function (successCallback, errorCallback){}

...

function fetchInboxMessages() {


    MappInappPlugin.fetchInboxMessages()(
        function (json) {
            alert(JSON.stringify(json));
        },
        function (json) {
            alert(JSON.stringify(json));
        });
}

Show In-App message (Android Only)

The method triggers an In-App message.
@param {string} event  - specific DCM event trigger. 

MappPlugin.prototype.fireInAppEvent = function fireInAppEvent(event,successCallback,errorCallback) {}

...

MappPlugin.prototype.setApplicationBadgeNumber = function (badgeNumber, successCallback, errorCallback){} 

 MappPlugin.onActionListener(
    function (json) {
        alert(JSON.stringify(json));
    },
    function (json) {
        alert(JSON.stringify(json));
    });

...

MappPlugin.prototype.removeBadgeNumber = function (successCallback, errorCallback){}

function removeBadgeNumber() {

     MappPlugin.removeBadgeNumber(
        function (json) {
            alert(JSON.stringify(json));
        },
        function (json) {
            alert(JSON.stringify(json));
        });
}

...