@selligent-marketing-cloud/selligent-react-native 2.5.0 → 2.6.0

package/RNSelligent.podspec

@@ -18,8 +18,8 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m}"
   s.requires_arc = true
 
-  s.vendored_libraries = "ios/libSelligentMobile2.6.1.a"
-  s.libraries = "SelligentMobile2.6.1"
+  s.vendored_libraries = "ios/libSelligentMobile2.7.a"
+  s.libraries = "SelligentMobile2.7"
 
   s.dependency "React"
   s.dependency 'PlotPlugin'

package/android/build.gradle

@@ -1,4 +1,3 @@
-
 buildscript {
     repositories {
         jcenter()
@@ -6,7 +5,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.3'
+        classpath 'com.android.tools.build:gradle:4.2.2'
     }
 }
 
@@ -27,17 +26,19 @@ android {
     lintOptions {
         abortOnError false
     }
+}
 
-    onVariantProperties { variant ->
+androidComponents {
+    onVariants(selector(), { variant ->
         def selligentSettings = loadSelligentSettings(variant)
         if (selligentSettings != null) {
             try {
                 variant.addBuildConfigField("SELLIGENT_SETTINGS", "\"" + selligentSettings + "\"", "Selligent settings")
             } catch (MissingMethodException ignored) {
-                throw new Exception("Selligent requires Android Gradle plugin version 4.1.0 or higher.")
+                throw new Exception("Selligent requires Android Gradle plugin version 4.2.0 or higher.")
             }
         }
-    }
+    })
 }
 
 repositories {
@@ -48,13 +49,12 @@ repositories {
 }
 
 dependencies {
-    implementation(name:'sdk-release', ext:'aar')
+    implementation(name: 'sdk-release', ext: 'aar')
 
     implementation 'com.facebook.react:react-native:+'
     implementation 'com.android.support:cardview-v7:27.1.1'
     implementation 'com.plotprojects:plot-android:3.13.1'
     implementation 'com.google.code.gson:gson:2.8.5'
-    implementation 'com.firebase:firebase-jobdispatcher:0.8.5'
     implementation 'com.google.firebase:firebase-messaging:21.0.0'
     implementation 'androidx.work:work-runtime:2.4.0'
     implementation 'androidx.concurrent:concurrent-futures:1.1.0'

package/android/src/main/java/com/selligent/RNSelligent.java

@@ -67,7 +67,6 @@ public class RNSelligent extends ReactContextBaseJavaModule implements Lifecycle
 
     public static void configure(Application application) {
         try {
-            SMManager.DEBUG = true;
             final HashMap<String, Object> settingsHashMap = new Gson().fromJson(
                     BuildConfig.SELLIGENT_SETTINGS, new TypeToken<HashMap<String, Object>>() {}.getType()
             );

package/constants.d.ts

@@ -25,6 +25,12 @@ export namespace InAppMessageType {
   const PASSBOOK: 5;
 }
 
+export namespace RemoteMessagesDisplayType {
+  const AUTOMATIC = 20;
+  const NONE = 21;
+  const NOTIFICATION = 22;
+}
+
 export namespace AndroidRemoteMessagesDisplayType {
   const AUTOMATIC = 20;
   const NONE = 21;

package/constants.js

@@ -1,4 +1,4 @@
-import {Platform} from 'react-native'
+import { Platform } from 'react-native'
 
 /**
  * @module SelligentConstants
@@ -36,7 +36,7 @@ var SelligentConstants = {
 	 * @description
 	 * Defines the in-app messages type.
 	 */
-	 InAppMessageType: {
+	InAppMessageType: {
 		UNKNOWN: -2,
 		HIDDEN: -1,
 		ALERT: 0,
@@ -46,6 +46,18 @@ var SelligentConstants = {
 		MAP: 4,
 		PASSBOOK: 5,
 	},
+	/**
+	 * @description
+	 * Defines if and how remote messages can be displayed.
+	 */
+	RemoteMessagesDisplayType: {
+		/** Display remote messages automatically */
+		AUTOMATIC: 20,
+		/** Don't display remote messages */
+		NONE: 21,
+		/** Display remote messages as notification */
+		NOTIFICATION: 22
+	},
 	/**
 	 * @description
 	 * Defines if and how remote messages can be displayed on Android.

package/index.d.ts

@@ -28,6 +28,9 @@ export function enableNotifications(
   errorCallback: Function,
   enabled: boolean
 ): void;
+export function registerForProvisionalRemoteNotification(
+  successCallback: Function
+): void;
 export function displayLastReceivedRemotePushNotification(
   successCallback: Function
 ): void;

package/index.ios.js

@@ -111,6 +111,18 @@ export default {
 		RNSelligent.forceRemoteNotificationBackgroundFetchResult(iOSBackgroundFetchResult)
 		return
 	},
+
+	/**
+	 * Register for Provisional Push Notifications.
+	 *  
+	 * @param {function} successCallback Callback function on success.
+	 */
+	registerForProvisionalRemoteNotification: function (successCallback) {
+		successCallback(SelligentHelpers.SUCCESS)
+		RNSelligent.registerForProvisionalRemoteNotification()
+		return
+	},
+
 	// Broadcasts Events
 
 	/**

package/ios/ClientSettings.h

@@ -13,6 +13,7 @@
 @property (nonatomic, strong, readonly) NSNumber *shouldDisplayRemoteNotification;
 @property (nonatomic, strong, readonly) NSNumber *configureLocationServices;
 @property (nonatomic, strong, readonly) NSNumber *clearCacheIntervalValue;
+@property (nonatomic, strong, readonly) NSNumber *remoteMessageDisplayType;
 @property (nonatomic, strong, readonly) InAppMessageSettings *inAppMessageSettings;
 
 @end

package/ios/ClientSettings.m

@@ -13,6 +13,7 @@
 @property (nonatomic, strong) NSNumber *shouldDisplayRemoteNotification;
 @property (nonatomic, strong) NSNumber *configureLocationServices;
 @property (nonatomic, strong) NSNumber *clearCacheIntervalValue;
+@property (nonatomic, strong) NSNumber *remoteMessageDisplayType;
 @property (nonatomic, strong) InAppMessageSettings *inAppMessageSettings;
 
 @end
@@ -30,6 +31,7 @@
     clientSettings.shouldDisplayRemoteNotification = dictionary[@"shouldDisplayRemoteNotification"];
     clientSettings.configureLocationServices = dictionary[@"configureLocationServices"];
     clientSettings.clearCacheIntervalValue = dictionary[@"clearCacheIntervalValue"];
+    clientSettings.remoteMessageDisplayType = dictionary[@"remoteMessageDisplayType"];
     clientSettings.inAppMessageSettings = [InAppMessageSettings fromDictionary:dictionary];
     return clientSettings;
 }

package/ios/EnumMapper.h

@@ -1,12 +1,14 @@
 #import <UIKit/UIKit.h>
 #import "LogLevel.h"
 #import "InAppMessageRefreshType.h"
+#import "RemoteMessageDisplayType.h"
 #import "LocationAuthorisationStatus.h"
 #import "LocationAuthorisationType.h"
 #import "ClearCacheInterval.h"
 #import "SMLog.h"
 #import "SMClearCache.h"
 #import "SMInAppRefreshType.h"
+#import "SMRemoteMessageDisplayType.h"
 #import "BackgroundFetchResult.h"
 #import "SMNotificationButtonType.h"
 #import "NotificationButtonType.h"
@@ -23,6 +25,8 @@
 - (SMInAppRefreshType)smInAppRefreshTypeForInAppMessageRefreshType:(InAppMessageRefreshType)inAppMessageRefreshType;
 - (InAppMessageRefreshType)inAppMessageRefreshTypeForSMInAppRefreshType:(SMInAppRefreshType)smInAppRefreshType;
 
+- (SMRemoteMessageDisplayType)smRemoteMessageDisplayTypeForRemoteMessageDisplayType: (RemoteMessageDisplayType)remoteMessageDisplayType;
+
 - (UIBackgroundFetchResult)uiBackgroundFetchResultForBackgroundFetchResult:(BackgroundFetchResult)backgroundFetchResult;
 - (BackgroundFetchResult)backgroundFetchResultForUIBackgroundFetchResult:(UIBackgroundFetchResult)uiBackgroundFetchResult;
 

package/ios/EnumMapper.m

@@ -4,6 +4,7 @@
     NSDictionary *_logLevelEnumMapping;
     NSDictionary *_clearCacheIntervalEnumMapping;
     NSDictionary *_inAppRefreshTypeEnumMapping;
+    NSDictionary *_remoteMessageDisplayTypeEnumMapping;
     NSDictionary *_locationAuthorisationStatusMapping;
     NSDictionary *_locationAuthorisationTypeMapping;
     NSDictionary *_backgroundFetchResult;
@@ -43,6 +44,11 @@
                                          @(iamrtHour) : @(kSMIA_RefreshType_Hourly),
                                          @(iamryDay ) : @(kSMIA_RefreshType_Daily),
                                          };
+        _remoteMessageDisplayTypeEnumMapping = @{
+            @(rmdtAutomatic) : @(kSMRemoteMessageDisplayType_Automatic),
+            @(rmdtNone) : @(kSMRemoteMessageDisplayType_None),
+            @(rmdtNotification) : @(kSMRemoteMessageDisplayType_Notification),
+        };
         _backgroundFetchResult = @{
                                    @(bfrNewData) : @(UIBackgroundFetchResultNewData),
                                    @(bfrNoData) : @(UIBackgroundFetchResultNoData),
@@ -91,6 +97,10 @@
     return (InAppMessageRefreshType) ((NSNumber *)[_inAppRefreshTypeEnumMapping allKeysForObject:@(smInAppRefreshType)].firstObject).integerValue;
 }
 
+-(SMRemoteMessageDisplayType)smRemoteMessageDisplayTypeForRemoteMessageDisplayType:(RemoteMessageDisplayType)remoteMessageDisplayType {
+    return (SMRemoteMessageDisplayType) ((NSNumber *)_remoteMessageDisplayTypeEnumMapping[@(remoteMessageDisplayType)]).integerValue;
+}
+
 - (UIBackgroundFetchResult)uiBackgroundFetchResultForBackgroundFetchResult:(BackgroundFetchResult)backgroundFetchResult {
     return (UIBackgroundFetchResult) ((NSNumber *)_backgroundFetchResult[@(backgroundFetchResult)]).integerValue;
 }

package/ios/RNSelligent.m

@@ -108,7 +108,7 @@ RCT_EXPORT_MODULE(RNSelligent)
     [[SMManager sharedInstance] willPresentNotification:notification withCompletionHandler:completionHandler];
 }
 
-+ (void)didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(void))completionHandler {
++ (void)didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)(UNNotificationContentExtensionResponseOption options))completionHandler {
     [[SMManager sharedInstance] didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
 }
 
@@ -229,6 +229,12 @@ RCT_EXPORT_METHOD(enableNotifications:(BOOL)enable) {
     }
 }
 
+RCT_EXPORT_METHOD(registerForProvisionalRemoteNotification) {
+    if (@available(iOS 12.0, *)) {
+        [[SMManager sharedInstance] registerForProvisionalRemoteNotification];
+    }
+}
+
 RCT_EXPORT_METHOD(displayLastReceivedRemotePushNotification) {
     [[SMManager sharedInstance] displayLastReceivedRemotePushNotification];
 }

package/ios/RemoteMessageDisplayType.h

@@ -0,0 +1,5 @@
+typedef enum RemoteMessageDisplayType : NSInteger {
+    rmdtAutomatic = 20,
+    rmdtNone = 21,
+    rmdtNotification = 22,
+} RemoteMessageDisplayType;

package/ios/SMManagerSetting+ClientSettings.m

@@ -1,4 +1,5 @@
 #import "SMManagerSetting+ClientSettings.h"
+#import "SMManagerSetting+Location.h"
 #import "SMManagerSettingIAM.h"
 #import "ClientSettings.h"
 #import "EnumMapper.h"
@@ -35,19 +36,24 @@
         settings.shouldClearBadge = shouldClearBadgeAsNumber.boolValue;
     }
     
+    if(clientSettings.configureLocationServices.boolValue) {
+        [settings configureLocationService];
+    }
+    
     NSNumber *shouldDisplayRemoteNotificationAsNumber = clientSettings.shouldDisplayRemoteNotification;
     if(shouldDisplayRemoteNotificationAsNumber) {
         settings.shouldDisplayRemoteNotification = shouldDisplayRemoteNotificationAsNumber.boolValue;
     }
     
-    if(clientSettings.configureLocationServices.boolValue) {
-        [settings configureLocationService];
-    }
-    
     NSNumber *clearCacheIntervalValueAsNumber = clientSettings.clearCacheIntervalValue;
     if(clearCacheIntervalValueAsNumber) {
         settings.clearCacheIntervalValue = [[EnumMapper sharedEnumMapper] smClearCacheForClearCacheInterval:clearCacheIntervalValueAsNumber.integerValue]; //((SMClearCache) );
     }
+    
+    NSNumber *remoteMessageDisplayType = clientSettings.remoteMessageDisplayType;
+    if(remoteMessageDisplayType) {
+        settings.remoteMessageDisplayType = [[EnumMapper sharedEnumMapper] smRemoteMessageDisplayTypeForRemoteMessageDisplayType:remoteMessageDisplayType.integerValue];
+    }
 }
 
 + (SMManagerSettingIAM *)_iamManagerSettingsFor:(ClientSettings *)clientSettings {

package/ios/include/SMBaseMessage.h

@@ -10,43 +10,39 @@
 
 /*!
  *  @discussion This is the Base class for message (push notif, in app message and in app content)
- *  #SMBaseMessage :#
  */
 @interface SMBaseMessage : NSObject
 
 /*!
  *  NSString instance providing the id of the message
  */
-@property (nonatomic) NSString *idMessage;
+@property (readonly, nonatomic) NSString *_Nullable idMessage;
 
 /*!
  *  NSDate instance providing the creation date of the message
- *  @deprecated Deprecated use receptionDate  instead
+ *
+ *  @warning Deprecated - use receptionDate  instead
  */
-@property (nonatomic) NSDate *dateCreation __deprecated __deprecated_msg("Use receptionDate instead");
+@property (readonly, nonatomic) NSDate *_Nullable dateCreation __deprecated __deprecated_msg("Use receptionDate instead");
 
 /*!
  *  NSDate instance providing the reception date on sdk side of the message
 */
-@property (nonatomic) NSDate *receptionDate;
+@property (readonly, nonatomic) NSDate *_Nullable receptionDate;
 
 /*!
  *  NSDate instance providing the expiration date of the message
  */
-@property (nonatomic) NSDate   *expirationDate;
+@property (readonly, nonatomic) NSDate *_Nullable expirationDate;
 
 /*!
  *  NSDate instance providing the creation date of the message
  */
-@property (nonatomic) NSDate   *creationDate;
+@property (readonly, nonatomic) NSDate *_Nullable creationDate;
 
 /*!
  *  bool instance infiorming if the message has already been displayed and viewed by user
  */
-@property (nonatomic) bool    isViewed;
+@property (readonly, nonatomic) bool isViewed;
 
-/*!
- *  bool instance infiorming if the message has  been deleted
- */
-@property (nonatomic) bool    isDeleted;
 @end

package/ios/include/SMBlock.h

@@ -12,10 +12,10 @@
  *  @typedef type of block that will be triggered when an event has been succesfully sent
  *  @param success a SMSuccess object
  */
-typedef void(^SMCompletionBlockSuccess)(SMSuccess *success);
+typedef void(^SMCompletionBlockSuccess)(SMSuccess *_Nullable success);
 
 /**
  *  @typedef type of block that will be triggered when an event has failed to be sent
  *  @param failure a SMFailure failure
  */
-typedef void(^SMCompletionBlockFailure)(SMFailure *failure);
+typedef void(^SMCompletionBlockFailure)(SMFailure *_Nullable failure);

package/ios/include/SMClearCache.h

@@ -6,10 +6,8 @@
 //  Copyright (c) 2015 Selligent. All rights reserved.
 //
 
-
 /**
  *  Enumeration used to define how often the SDK's cache should automaticaly clear itself
- *  #SMClearCache :#
  */
 typedef NS_ENUM(NSInteger, SMClearCache) {
     /**

package/ios/include/SMContentAlignment.h

@@ -7,7 +7,7 @@
 //
 
 /**
- *  #SMContentAlignment :#
+ *
  */
 typedef NS_ENUM(NSInteger, SMContentAlignment) {
     /*!
@@ -25,4 +25,3 @@ typedef NS_ENUM(NSInteger, SMContentAlignment) {
      */
     kSMAlignCenter
 };
-

package/ios/include/SMDeviceInfos.h

@@ -9,28 +9,30 @@
 #import <Foundation/Foundation.h>
 
 /*!
- * #SMDeviceInfos :#
  */
 @interface SMDeviceInfos : NSObject
 
 /*!
  *  Any External Id in your possession that you wish to transmit to the back-end
- *  @discussion NSString
+ *
+ *  @discussion NSString representing your external, custom identifier.
  *  By default, it is an empty string
  */
 @property (nonatomic) NSString* _Nullable externalId;
 
 /*!
  *  Create a generic deviceinfos object
- *  @return a SMDeviceInfos object
+ *
+ *  @return An SMDeviceInfos object
  */
-+ (instancetype _Nullable )defaultDeviceInfos;
++ (instancetype _Nullable ) defaultDeviceInfos;
 
 /*!
  *  Create a deviceinfos object with an external id property already set with the value provided
- *  @param externalId a string containing the id you want to provide to the back-end
- *  @return a SMDeviceInfos object
+ *
+ *  @param externalId An string containing the id you want to provide to the back-end
+ *  @return An SMDeviceInfos object
  */
-+ (instancetype _Nullable )deviceInfosWithExternalId:(NSString*_Nullable) externalId;
++ (instancetype _Nullable ) deviceInfosWithExternalId:(NSString*_Nullable) externalId;
 
 @end

package/ios/include/SMDisplayMode.h

@@ -6,9 +6,8 @@
 //  Copyright © 2016 Selligent. All rights reserved.
 //
 
-
 /*!
- *  #SMDisplayMode :#
+ *
  */
 typedef NS_ENUM(NSInteger, SMDisplayMode) {
     /*!

package/ios/include/SMEvent.h

@@ -11,15 +11,11 @@
 #import "SMFailure.h"
 #import "SMSuccess.h"
 
-
-
 /*!
- * @discussion This is the Base class for all type of events
- * #SMEvent :#
+ * This is the Base class for all type of events
  */
 @interface SMEvent : NSObject
 
-
 /*!
  *  Confirm if the current event should be cached or not
  *  @discussion If the event fail to be delivered to your backend, then by default, it is cached into an internal queue.
@@ -29,36 +25,44 @@
  */
 @property (nonatomic) BOOL shouldCache;
 
-
-
 /*!
  *  Create a generic event object that will be sent to platform
- *  @param dict a Dictionary containing any kind of custom datas that must be stored and managed by platform
- *  @return a SMEvent object
+ *
+ *  @param dict A Dictionary containing any kind of custom datas that must be stored and managed by platform
+ *  @return An SMEvent object
  */
-+ (instancetype _Nonnull)eventWithDictionary:(NSDictionary* _Nullable)dict;
++ (instancetype _Nonnull) eventWithDictionary:(NSDictionary* _Nullable)dict;
 
 /*!
  *  Allow to initialise a success block and/or a failure block that will be triggered after an event is sent to the platform
  *
- *  @param blockSuccess a SMCompletionBlockSuccess block that will be triggered if the send to the platform is successfull
- *  @param blockFailure a SMCompletionBlockFailure block that will be triggered if the send to the platform has failed
+ *  @param blockSuccess An SMCompletionBlockSuccess block that will be triggered if the send to the platform is successfull
+ *  @param blockFailure An SMCompletionBlockFailure block that will be triggered if the send to the platform has failed
  *  @discussion This method may be used as follow:
  *
  *  @code
  *  NSDictionary *dictMyCustomData = @{@"MyKey": @"MyValue"};
+ *
  *  SMEvent *event = [SMEvent eventWithDictionary:dictMyCustomData];
- *  [event applyBlockSuccess:^(SMSuccess *success) { 
- *  //  My code for success} 
- *  BlockFailure:^(SMFailure *failure) { 
+ *
+ *  [event applyBlockSuccess:^(SMSuccess *success) {
+ *
+ *  //  My code for success}
+ *
+ *  BlockFailure:^(SMFailure *failure) {
+ *
  *  //  My code for failure }];
+ *
  *  [[SMManager sharedInstance] sendSMEvent:event];
  *  @endcode
+ *  
  *  This method is optional. Use it only if you need it.
  *  @warning It is developer's responsability to make sure no strong retrain cycles are added to the completion-blocks.
  *  Make sure to read the following [Apple documentation.](https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/WorkingwithBlocks/WorkingwithBlocks.html#//apple_ref/doc/uid/TP40011210-CH8-SW16)
+ *  @see SMCompletionBlockSuccess
+ *  @see SMCompletionBlockFailure
  */
-- (void)applyBlockSuccess:(SMCompletionBlockSuccess _Nullable)blockSuccess BlockFailure:(SMCompletionBlockFailure _Nullable)blockFailure;
+- (void) applyBlockSuccess:(SMCompletionBlockSuccess _Nullable)blockSuccess BlockFailure:(SMCompletionBlockFailure _Nullable)blockFailure;
 
 @end
 

package/ios/include/SMEventUser.h

@@ -9,7 +9,6 @@
 #import "SMEvent.h"
 
 /*!
- *  @inherits SMEvent
  *  @discussion Class representing all User-eventing
  *  Instances of this class should not be directly created.
  *  Please use children classes instead.

package/ios/include/SMEventUserLogin.h

@@ -9,38 +9,33 @@
 #import "SMEventUser.h"
 
 /*!
- * @class SMEventUserLogin
- * @inherits SMEventUser
- * @discussion user login event class
- * #SMEventUserLogin:#
+ * User login event class
  */
 @interface SMEventUserLogin : SMEventUser
 
-
 /*!
  *  Create a UserLogin event object that will be sent to selligent platform when user logged in
  *
- *  @param mail the e-mail of the user
- *  @return a SMEventUserLogin object
+ *  @param mail The e-mail of the user
+ *  @return An SMEventUserLogin object
  */
-+ (instancetype _Nonnull)eventWithEmail:(NSString*_Null_unspecified)mail;
++ (instancetype _Nonnull) eventWithEmail:(NSString*_Null_unspecified)mail;
 
 /*!
  *  Create a UserLogin event object that will be sent to selligent platform when user logged in
  *
- *  @param mail the e-mail of the user
- *  @param dict a Dictionary containing a string as data that must be stored and managed by platform
+ *  @param mail The e-mail of the user
+ *  @param dict A Dictionary containing a string as data that must be stored and managed by platform
  *  If email is not provided you can use in the dictionary an alternate key/value field to search for the user
- *     example: [SMEventUserLogin eventWithEmail @"" Dictionary: @{@"userID": @"1234"}];
- *  @return a SMEventUserLogin object
+ *  @return An SMEventUserLogin object
  */
-+ (instancetype _Nonnull)eventWithEmail:(NSString*_Null_unspecified)mail Dictionary:(NSDictionary<NSString*,NSString*>*_Nullable)dict;
++ (instancetype _Nonnull) eventWithEmail:(NSString*_Null_unspecified)mail Dictionary:(NSDictionary<NSString*,NSString*>*_Nullable)dict;
 
 /*!
  *  Create a UserLogin event object that will be sent to platform
- *  @param dict a Dictionary containing an alternate key/value field to search for the user
- *     example: [SMEventUserLogin eventWithDictionary: @{@"userID": @"1234"}];
- *  @return a SMEventUserLogin object
+ *
+ *  @param dict A Dictionary containing an alternate key/value field to search for the user
+ *  @return An SMEventUserLogin object
  */
 + (instancetype _Nonnull)eventWithDictionary:(NSDictionary* _Nullable)dict;
 

package/ios/include/SMEventUserLogout.h

@@ -9,38 +9,34 @@
 #import "SMEventUser.h"
 
 /*!
- * @class SMEventUserLogout
- * @inherits SMEventUser
- * @discussion user logout event class
- * #SMEventUserLogout:#
+ * User logout event class
  */
 @interface SMEventUserLogout : SMEventUser
 
 /*!
  *  Create a UserLogout event object that will be sent to selligent platform when user logged out
  *
- *  @param mail the e-mail of the user
- *  @return a SMEventUserLogout object
+ *  @param mail The e-mail of the user
+ *  @return An SMEventUserLogout object
  */
-+ (instancetype _Nonnull)eventWithEmail:(NSString*_Null_unspecified)mail;
++ (instancetype _Nonnull) eventWithEmail:(NSString*_Null_unspecified)mail;
 
 /*!
  *  Create a UserLogout event object that will be sent to selligent platform when user logged out
  *
- *  @param mail the e-mail of the user
- *  @param dict a Dictionary containing a string as data that must be stored and managed by platform
+ *  @param mail The e-mail of the user
+ *  @param dict A Dictionary containing a string as data that must be stored and managed by platform
  *  If email is not provided you can use in the dictionary an alternate key/value field to search for the user
- *     example: [SMEventUserLogout eventWithEmail @"" Dictionary: @{@"userID": @"1234"}];
- *  @return a SMEventUserLogout object
+ *  @return An SMEventUserLogout object
  */
-+ (instancetype _Nonnull)eventWithEmail:(NSString*_Null_unspecified)mail Dictionary:(NSDictionary<NSString*,NSString*>*_Nullable)dict;
++ (instancetype _Nonnull) eventWithEmail:(NSString*_Null_unspecified)mail Dictionary:(NSDictionary<NSString*,NSString*>*_Nullable)dict;
 
 /*!
  *  Create a UserLogout event object that will be sent to platform
- *  @param dict a Dictionary containing an alternate key/value field to search for the user
- *     example: [SMEventUserLogout eventWithDictionary:@{@"userID": @"1234"}];
- *  @return a SMEventUserLogout object
+ *
+ *  @param dict A Dictionary containing an alternate key/value field to search for the user
+ *  @return An SMEventUserLogout object
  */
-+ (instancetype _Nonnull)eventWithDictionary:(NSDictionary* _Nullable)dict;
++ (instancetype _Nonnull) eventWithDictionary:(NSDictionary* _Nullable)dict;
 
 @end