@selligent-marketing-cloud/selligent-react-native 3.0.0 → 3.2.6

package/helpers.js

@@ -1,6 +1,4 @@
-import {Platform} from 'react-native'
-
-var SelligentHelpers = {};
+const SelligentHelpers = {};
 
 // ARGUMENTS SUCCESS MESSAGES
 SelligentHelpers.SUCCESS = "Action successful";
@@ -65,15 +63,16 @@ SelligentHelpers.wrongArgumentError = function (message) {
 }
 
 SelligentHelpers.constantIsValid = function (constants, constantToVerify) {
-	var occursInConstants = false,
+	let occursInConstants = false,
 		occursInAndroidSubConstants = false,
 		occursInIOSSubConstants = false;
 
-	Object.keys(constants).map(function (constant) {
-		if (constants[constant] == constantToVerify) {
+	Object.keys(constants).forEach(function (constant) {
+		if (constants[constant] === constantToVerify) {
 			occursInConstants = true;
 		}
 	});
+
 	return occursInConstants || occursInAndroidSubConstants || occursInIOSSubConstants;
 };
 

package/index.android.js

@@ -1,10 +1,9 @@
 // Android specific methods
-import { NativeEventEmitter, NativeModules } from 'react-native'
+import { NativeModules } from 'react-native'
 import SelligentConstants from './constants'
 import SelligentHelpers from './helpers'
 
 const { RNSelligent } = NativeModules
-const RNSEventEmitter = new NativeEventEmitter(RNSelligent)
 
 export default {
 	// Basic SMManager
@@ -18,17 +17,20 @@ export default {
 	 *
 	 * @param {function} successCallback Callback function on success.
 	 * @param {function} errorCallback Callback function on error.
-	 * @param {(boolean|InAppMessageRefreshType)} options Boolean to enable/disable in-app messages or an enum InAppMessageRefreshType to enable and set which in-app messages should be enabled.
+	 * @param {(boolean|InAppMessageRefreshType)} enabled Boolean to enable/disable in-app messages or an enum InAppMessageRefreshType to enable and set which in-app messages should be enabled.
 	 */
 	enableInAppMessages: function (successCallback, errorCallback, enabled) {
 		if (!SelligentHelpers.typeMatches(enabled, 'number') && !SelligentHelpers.typeMatches(enabled, 'boolean')) {
 			errorCallback(SelligentHelpers.wrongArgumentError('Expected a boolean or a number.'))
 			return
 		}
+		else if (SelligentHelpers.typeMatches(enabled, 'number') && !Object.values(SelligentConstants.InAppMessageRefreshType).includes(enabled)) {
+			errorCallback(SelligentHelpers.wrongArgumentError('Value should be one from InAppMessageRefreshType'))
+			return
+		}
 
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.enableInAppMessages({ enabled })
-		return
 	},
 
 	/**
@@ -40,31 +42,13 @@ export default {
 		return RNSelligent.areInAppMessagesEnabled(successCallback)
 	},
 
-	/**
-	 * Display message on Android.
-	 *
-	 * @param {function} successCallback Callback function on success.
-	 * @param {function} errorCallback Callback function on error.
-	 * @param {string} messageId Id of the message.
-	 */
-	displayMessage: function (successCallback, errorCallback, messageId) {
-		if (!SelligentHelpers.typeMatches(messageId, 'string')) {
-			errorCallback(SelligentHelpers.wrongArgumentError('Expected a string.'))
-			return
-		}
-
-		successCallback(SelligentHelpers.SUCCESS)
-		RNSelligent.displayMessage(messageId)
-		return
-	},
-
 	// Log
 	/**
 	 * Enable logging messages on Android.
 	 *
 	 * @param {function} successCallback Callback function on success.
 	 * @param {function} errorCallback Callback function on error.
-	 * @param {boolean} shouldEnableLoggingMessages Boolean to enable/disable logging messages on Android.
+	 * @param {boolean} enabled Boolean to enable/disable logging messages on Android.
 	 */
 	enableAndroidLogging: function (successCallback, errorCallback, enabled) {
 		if (!SelligentHelpers.typeMatches(enabled, 'boolean')) {
@@ -74,7 +58,6 @@ export default {
 
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.setDebug(enabled)
-		return
 	},
 	// Remote Notification
 
@@ -85,7 +68,6 @@ export default {
 	 */
 	areNotificationsEnabled: function (successCallback) {
 		RNSelligent.areNotificationsEnabled(successCallback)
-		return
 	},
 
 	/**
@@ -103,7 +85,6 @@ export default {
 
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.setNotificationSmallIcon(iconName)
-		return
 	},
 
 	/**
@@ -121,7 +102,6 @@ export default {
 
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.setNotificationLargeIcon(iconName)
-		return
 	},
 
 	/**
@@ -142,7 +122,6 @@ export default {
 		}
 
 		RNSelligent.setNotificationIconColor(color, _successCallback, errorCallback)
-		return
 	},
 
 	/**
@@ -163,7 +142,6 @@ export default {
 		}
 
 		RNSelligent.setNotificationActivity(activityName, _successCallback, errorCallback)
-		return
 	},
 
 	/**
@@ -173,69 +151,17 @@ export default {
 	 */
 	getGCMToken: function (successCallback) {
 		RNSelligent.getGCMToken(successCallback)
-		return
 	},
 
 	/**
 	 * Get remote messages display type.
 	 *
 	 * @param {function} successCallback Callback function on success.
-	 * @param {function} errorCallback Callback function on error.
 	 */
 	getRemoteMessagesDisplayType: function (successCallback) {
 		RNSelligent.getRemoteMessagesDisplayType(successCallback)
-		return
 	},
-	// Broadcasts Events
-
-	/**
-	 * Subscribe to events.
-	 *
-	 * @param {function} successCallback Callback function on success.
-	 * @param {function} errorCallback Callback function on error.
-	 * @param {function} eventCallback Callback function on event.
-	 * @param {array} customEvents Array of custom events to subscribe to.
-	 */
-	subscribeToEvents: function (successCallback, errorCallback, eventCallback, customEvents = []) {
-
-		if (customEvents !== undefined) {
-			if (!SelligentHelpers.typeMatches(customEvents, 'array')) {
-				errorCallback(SelligentHelpers.createTypeErrorMessage('customEvents', customEvents, 'array'))
-				return
-			}
-
-			// check if values are all strings
-			var arrayLength = customEvents.length
-			for (var i = 0; i < arrayLength; i++) {
-				if (!SelligentHelpers.typeMatches(customEvents[i], 'string')) {
-					errorCallback(SelligentHelpers.wrongArgumentError('Expected an array of strings.'))
-					return
-				}
-			}
-		}
-
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.BUTTON_CLICKED, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_IN_APP_MESSAGE, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.WILL_DISPLAY_NOTIFICATION, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.WILL_DISMISS_NOTIFICATION, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_GCM_TOKEN, eventCallback);
-
-		successCallback(SelligentHelpers.SUCCESS)
-		RNSelligent.subscribeToEvents(customEvents)
-		return
-	},
-
-	/**
-	 * Subscribe to event.
-	 *
-	 * @param {function} eventCallback Callback function on event.
-	 * @param {string} eventName Name of the event to subscribe to.
-	 */
-	subscribeToEvent: function (eventCallback, eventName) {
-		RNSEventEmitter.addListener(eventName, eventCallback);
-		return
-	},
-
+	
 	/**
 	 * Set the firebase (GCM) token
 	 *
@@ -251,6 +177,5 @@ export default {
 
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.setFirebaseToken(token)
-		return
 	},
 }

package/index.d.ts

@@ -5,18 +5,22 @@ export function setInAppMessageAsSeen(
   errorCallback: Function,
   messageId: string
 ): void;
-export function executeButtonAction(
+export function setInAppMessageAsUnseen(
   successCallback: Function,
   errorCallback: Function,
-  buttonId: string,
   messageId: string
 ): void;
-export function enableGeolocation(
+export function setInAppMessageAsDeleted(
   successCallback: Function,
   errorCallback: Function,
-  enabled: boolean
+  messageId: string
+): void;
+export function executeButtonAction(
+  successCallback: Function,
+  errorCallback: Function,
+  buttonId: string,
+  messageId: string
 ): void;
-export function isGeolocationEnabled(successCallback: Function): void;
 export function sendEvent(
   successCallback: Function,
   errorCallback: Function,
@@ -28,57 +32,53 @@ export function enableNotifications(
   errorCallback: Function,
   enabled: boolean
 ): void;
-export function registerForProvisionalRemoteNotification(
-  successCallback: Function
-): void;
 export function displayLastReceivedRemotePushNotification(
-  successCallback: Function
+  successCallback: Function,
+  templateId?: string
 ): void;
+export function displayLastReceivedNotification(): void;
 export function getLastRemotePushNotification(successCallback: Function): void;
-
-// IOS
 export function enableInAppMessages(
   successCallback: Function,
   errorCallback: Function,
-  enabled: boolean
+  enabled: boolean | number
 ): void;
-export function enableiOSLogging(
+export function subscribeToEvents(
   successCallback: Function,
   errorCallback: Function,
-  logLevels: any[]
+  eventCallback: Function,
+  customEvents?: any[]
+): void;
+export function subscribeToEvent(
+  eventCallback: Function,
+  eventName: string
 ): void;
 export function displayNotification(
   successCallback: Function,
   errorCallback: Function,
-  notificationId: string
-): void;
-export function registerRemoteNotificationFetchCompletionHandler(
-  successCallback: Function,
-  eventCallback: Function
+  notificationId: string,
+  templateId?: string
 ): void;
-export function forceRemoteNotificationBackgroundFetchResult(
+export function displayMessage(
   successCallback: Function,
   errorCallback: Function,
-  iOSBackgroundFetchResult: any
+  messageId: string,
+  templateId?: string
 ): void;
-export function subscribeToEvents(
+
+// IOS
+export function enableiOSLogging(
   successCallback: Function,
   errorCallback: Function,
-  eventCallback: Function
+  logLevels: any[]
 ): void;
+export function registerForProvisionalRemoteNotification(
+  successCallback: Function
+): void;
+export function executePushAction(): void;
 
 // ANDROID
-export function enableInAppMessages(
-  successCallback: Function,
-  errorCallback: Function,
-  enabled: boolean | number
-): void;
 export function areInAppMessagesEnabled(successCallback: Function): any;
-export function displayMessage(
-  successCallback: Function,
-  errorCallback: Function,
-  messageId: string
-): void;
 export function enableAndroidLogging(
   successCallback: Function,
   errorCallback: Function,
@@ -107,16 +107,6 @@ export function setNotificationActivity(
 ): void;
 export function getGCMToken(successCallback: Function): void;
 export function getRemoteMessagesDisplayType(successCallback: Function): void;
-export function subscribeToEvents(
-  successCallback: Function,
-  errorCallback: Function,
-  eventCallback: Function,
-  customEvents?: any[]
-): void;
-export function subscribeToEvent(
-  eventCallback: Function,
-  eventName: string
-): void;
 export function setFirebaseToken(
   successCallback: Function,
   errorCallback: Function,

package/index.ios.js

@@ -1,10 +1,9 @@
 // iOS specific methods
-import { NativeEventEmitter, NativeModules } from 'react-native'
+import { NativeModules } from 'react-native'
 import SelligentConstants from './constants'
 import SelligentHelpers from './helpers'
 
 const { RNSelligent } = NativeModules
-const RNSEventEmitter = new NativeEventEmitter(RNSelligent)
 
 export default {
 	// Basic SMManager
@@ -16,17 +15,30 @@ export default {
 	 *  
 	 * @param {function} successCallback Callback function on success.
 	 * @param {function} errorCallback Callback function on error.
-	 * @param {boolean} enabled Boolean to enable/disable in-app messages.
+	 * @param {boolean | number} enabled Boolean to enable/disable in-app messages.
 	 */
 	enableInAppMessages: function (successCallback, errorCallback, enabled) {
-		if (!SelligentHelpers.typeMatches(enabled, 'boolean')) {
-			errorCallback(SelligentHelpers.wrongArgumentError('Expected a boolean.'))
+		if (!SelligentHelpers.typeMatches(enabled, 'number') && !SelligentHelpers.typeMatches(enabled, 'boolean')) {
+			errorCallback(SelligentHelpers.wrongArgumentError('Expected a boolean or a number.'))
 			return
 		}
 
+		let result;
+
+		if (typeof enabled === 'boolean'){
+			result = enabled
+		}
+		else {
+			if (!Object.values(SelligentConstants.InAppMessageRefreshType).includes(enabled)) {
+				errorCallback(SelligentHelpers.wrongArgumentError('Value should be one from InAppMessageRefreshType'))
+				return
+			}
+
+			result = enabled !== SelligentConstants.InAppMessageRefreshType.NONE;
+		}
+
 		successCallback(SelligentHelpers.SUCCESS)
-		RNSelligent.enableInAppMessages(enabled)
-		return
+		RNSelligent.enableInAppMessages(result)
 	},
 	// Log
 
@@ -44,8 +56,8 @@ export default {
 		}
 
 		// check if values are all numbers and iOS Loglevels
-		var arrayLength = logLevels.length
-		for (var i = 0; i < arrayLength; i++) {
+		const arrayLength = logLevels.length;
+		for (let i = 0; i < arrayLength; i++) {
 
 			if (!SelligentHelpers.typeMatches(logLevels[i], 'number')) {
 				errorCallback(SelligentHelpers.wrongArgumentError('Expected a number.'))
@@ -60,58 +72,9 @@ export default {
 
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.applyLogLevel(logLevels)
-		return
 	},
 	// Remote Notification
 
-	/**
-	 * Display notification by id on iOS.
-	 * 
-	 * @param {function} successCallback Callback function on success.
-	 * @param {function} errorCallback Callback function on error.
-	 * @param {string} notificationId Id of the notification.
-	 */
-	displayNotification: function (successCallback, errorCallback, notificationId) {
-		if (!SelligentHelpers.typeMatches(notificationId, 'string') || notificationId.length === 0) {
-			errorCallback(SelligentHelpers.wrongArgumentError('Expected a string (not empty).'))
-			return
-		}
-
-		successCallback(SelligentHelpers.SUCCESS)
-		RNSelligent.displayNotification(notificationId)
-		return
-	},
-
-	/**
-	 * Register a completion handler for successfully fetching remote notifications.
-	 * 
-	 * @param {function} successCallback Completion handler.
-	 * @param {function} eventCallback Callback function on event.
-	 */
-	registerRemoteNotificationFetchCompletionHandler: function (successCallback, eventCallback) {
-		RNSEventEmitter.addListener(SelligentConstants.RemoteNotification.FETCHED_REMOTE_NOTIFICATION, eventCallback);
-		successCallback(SelligentHelpers.SUCCESS)
-		return
-	},
-
-	/**
-	 * Force the result of a remote notification fetch to be a specific value.
-	 * 
-	 * @param {function} successCallback Callback function on success.
-	 * @param {function} errorCallback Callback function on error.
-	 * @param {iOSBackgroundFetchResult} iOSBackgroundFetchResult Type of result to force, when fetching remote notifications.
-	 */
-	forceRemoteNotificationBackgroundFetchResult: function (successCallback, errorCallback, iOSBackgroundFetchResult) {
-		if (!SelligentHelpers.typeMatches(iOSBackgroundFetchResult, 'number') || !SelligentHelpers.constantIsValid(SelligentConstants.iOSBackgroundFetchResult, iOSBackgroundFetchResult)) {
-			errorCallback(SelligentHelpers.wrongArgumentError('Expected a value of Selligent constant enum "iOSBackgroundFetchResult".'))
-			return
-		}
-
-		successCallback(SelligentHelpers.SUCCESS)
-		RNSelligent.forceRemoteNotificationBackgroundFetchResult(iOSBackgroundFetchResult)
-		return
-	},
-
 	/**
 	 * Register for Provisional Push Notifications.
 	 *  
@@ -120,26 +83,12 @@ export default {
 	registerForProvisionalRemoteNotification: function (successCallback) {
 		successCallback(SelligentHelpers.SUCCESS)
 		RNSelligent.registerForProvisionalRemoteNotification()
-		return
 	},
 
-	// Broadcasts Events
-
 	/**
-	 * Subscribe to events.
-	 * 
-	 * @param {function} successCallback Callback function on success.
-	 * @param {function} errorCallback Callback function on error.
-	 * @param {function} eventCallback Callback function on event.
+	 * Tells the Selligent SDK to execute the action associated to the last push clicked, when using `delayedPushAction` feature
 	 */
-	subscribeToEvents: function (successCallback, errorCallback, eventCallback) {
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_IN_APP_MESSAGE, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.WILL_DISPLAY_NOTIFICATION, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.WILL_DISMISS_NOTIFICATION, eventCallback);
-		RNSEventEmitter.addListener(SelligentConstants.BroadcastEventType.RECEIVED_REMOTE_NOTIFICATION, eventCallback);
-
-		successCallback(SelligentHelpers.SUCCESS)
-		RNSelligent.subscribeToEvents()
-		return
+	executePushAction: function () {
+		RNSelligent.executePushAction()
 	}
-}
+}