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

package/ios/include/SMInAppMessage.h

@@ -1,5 +1,5 @@
 //
-//  SellNotificationMessage.h
+//  SMInAppMessage.h
 //  MobileSDK
 //
 //  Created by Gilbert Schakal on 19/05/15.
@@ -10,34 +10,42 @@
 #import "SMBaseMessage.h"
 #import "SMInAppMessageType.h"
 
+@interface SMInAppMessage : SMBaseMessage
+
 /*!
- *
- *  #SMInAppMessage :#
+ *  NSString instance providing the title of the inapp-notification
  */
-@interface SMInAppMessage : SMBaseMessage
+@property (readonly, nonatomic) NSString *_Nullable title;
 
 /*!
- *  NSString instance providing the title of the message
+ *  NSString instance providing the content of the inapp-notification
  */
-@property (nonatomic) NSString     *title;
+@property (readonly, nonatomic) NSString *_Nullable body;
+
+/*!
+ *  NSArray of SMNotificationAnnotationData  objects for map inapp-notification
+ */
+@property (readonly, nonatomic) NSArray *_Nullable arrayMapAnnotations;
+
 /*!
- *  NSString instance providing the content of the message
+ *  NSArray of SMLink objects from the inapp-notification
  */
-@property (nonatomic) NSString     *body;
+@property (readonly, nonatomic) NSArray *_Nullable arrayIAMLinks;
 
 /*!
- *  NSArray of SMNotificationAnnotationData  objects for map In App message
+ *  SMInAppMessageType instance providing the in inapp-notification type
+ *  @see SMInAppMessageType
  */
-@property (nonatomic) NSArray *arrayMapAnnotations;
+@property (readonly, nonatomic) SMInAppMessageType iamType;
 
 /*!
- *  NSArray of SMLink objects
+ *  NSString instance providing the title of the remote-notification
  */
-@property (nonatomic) NSArray *arrayIAMLinks;
+@property (readonly, nonatomic) NSString *_Nullable apsTitle;
 
 /*!
- *  SMInAppMessageType instance providing the in app message  type
+ *  NSString instance providing the body of the remote-notification
  */
-@property (nonatomic) SMInAppMessageType  iamType;
+@property (readonly, nonatomic) NSString *_Nullable apsBody;
 
 @end

package/ios/include/SMInAppMessageType.h

@@ -6,11 +6,7 @@
 //  Copyright © 2020 Selligent. All rights reserved.
 //
 
-/*!
- *  #SMInAppMessageType :#
- */
-typedef NS_ENUM (NSInteger, SMInAppMessageType){
-    
+typedef NS_ENUM (NSInteger, SMInAppMessageType) {
     /*!
      *  In App message of unknown type.
      */

package/ios/include/SMInAppRefreshType.h

@@ -7,7 +7,7 @@
 //
 
 /*!
- *  #SMInAppRefreshType :#
+ * 
  */
 typedef NS_ENUM(NSInteger, SMInAppRefreshType) {
     /*!

package/ios/include/SMLink.h

@@ -7,37 +7,33 @@
 //
 
 #import <Foundation/Foundation.h>
-
-
 #import "SMNotificationButtonType.h"
 
-
-
 /**
- *  #SMLink :#
+ *
  */
 @interface SMLink : NSObject
 
 /*!
  *  NSString instance providing the id of the button
  */
-@property (nonatomic, strong) NSString     * idButtonData;
+@property (readonly, nonatomic, strong) NSString *_Nullable idButtonData;
 
 /*!
  *  NSString instance providing the label of the button
  */
-@property (nonatomic, strong) NSString     * label;
+@property (readonly, nonatomic, strong) NSString *_Nullable label;
 
 /*!
  *  NSString instance providing the value of the button
  */
-@property (nonatomic, strong) NSString     * value;
+@property (readonly, nonatomic, strong) NSString *_Nullable value;
 
 /*!
  *  The type (SMNotificationButtonType) of action that the button will execute.
- *  @see SMNotificationButtonType for more information about each type
+ *  
+ *  @see SMNotificationButtonType 
  */
-@property (nonatomic) SMNotificationButtonType type;
-
+@property (readonly, nonatomic) SMNotificationButtonType type;
 
 @end

package/ios/include/SMLog.h

@@ -9,7 +9,7 @@
 /*!
  *  Enumeration type for the log granularity
  */
-typedef NS_OPTIONS(NSInteger, SMLogLevel){
+typedef NS_OPTIONS(NSInteger, SMLogLevel) {
     /*!
      *  No log printed at all.
      *  This is the suggested log-level for release.

package/ios/include/SMManager+DataTransaction.h

@@ -5,36 +5,29 @@
 //  Created by Gilbert Schakal on 08/02/2017.
 //  Copyright © 2017 Selligent. All rights reserved.
 //
+
 #import "SMManager.h"
 #import "SMDeviceInfos.h"
 
-
 /**
  *  This category will help you to retrieve or send specific information to the selligent platform.
- *
- *  #SMManager+DataTransaction :#
  */
 @interface SMManager (DataTransaction)
 
-
 /**
- *  @warning Deprecated method
  *  @discussion In order to send device informations to the back-end you can use
- *
- *  - sendDeviceInfo:(SMDeviceInfos*)infos;
+ *  @warning Deprecated method
  */
--(void)sendDeviceInfo __deprecated;
-
+- (void) sendDeviceInfo __deprecated __deprecated_msg("Use sendDeviceInfo: instead.");
 
 /*!
  *  This method allow you to send an event with pre-defined devices informations to the back-end
- *  
- *  @discussion The informations to be sent will be set in a SMDeviceInfos object. Each property of the created object will be a data that will be provided to the back-end. For additional informations you can refer to SMDevicesInfos.
  *
+ *  @discussion The informations to be sent will be set in a SMDeviceInfos object. Each property of the created object will be a data that will be provided to the back-end. For additional informations you can refer to SMDevicesInfos.
  *  This call can be done at any time  after starting the library and if the properties of SMDeviceInfos object has not changed from a previous call, the event will not be sent to avoid platform unnecessarily overload.
- *
  *  @param deviceInfos SMDeviceInfos object
+ *  @see SMDeviceInfos
  */
--(void)sendDeviceInfo:(SMDeviceInfos*)deviceInfos;
+- (void) sendDeviceInfo:(SMDeviceInfos*_Nullable)deviceInfos;
 
 @end

package/ios/include/SMManager+InAppContent.h

@@ -13,16 +13,14 @@
 
 @class SMInAppContentViewController;
 
-
 /*!
- *  #Introduction :#
  *  In-Application-Content (IAC) is an optional service which will retrieve messages from the back-end each time the application enters foregrounds at specific frequencies and if connection is available.
  *
  *  Once new messages were retrieved, the library notifies the application about it.
  *
- *  Each IAC is is from a specific type [SMInAppContentType] and is also linked to a category defined by yourself
+ *  Each IAC is is from a specific type (SMInAppContentType) and is also linked to a category defined by yourself
  *
- *  #Implementation :#
+ *  ##Implementation
  *  In a nutshell, activate the IAC-service is a one step process:
  *
  *  *  Create an SMManagerSettingIAC instance and inject it in SMManagerSetting with [SMManagerSetting configureInAppContentServiceWithSetting:]
@@ -32,7 +30,7 @@
  *  This notification will provide you with the number of IAC's by category.
  *  Please be aware that it’s the unique application’s chance to capture and store that information.
  *
- *  #Displaying IAC :#
+ *  ##Displaying IAC
  *
  *  * With the SDK view controllers:
  *
@@ -64,7 +62,7 @@
  *
  * ` -(void) prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender
  * {
- *   if([segue.identifier isEqualToString:@"YourSegue"]){
+ *   if ([segue.identifier isEqualToString:@"YourSegue"]) {
  *       _sminappcontentviewcontroller = segue.destinationViewController;
  *       [self.sminappcontentviewcontroller setCategory:@"anycategory"];
  *   }
@@ -78,7 +76,7 @@
  *
  *  If you decide to use this way of interacting with IAC it is important that you keep in mind that you will be responsible of the display of the content and you will have to call to setInAppContentAsSeen: whenever an InAppContent is showed to the user and to executeLinkAction:InAppContent: whenever user interact with an action link of the in app content.
  *
- *  #Fetching modes :#
+ *  ##Fetching modes
  *  IAC may be retrieved from two different modes corresponding to the application's state:
  *
  *  * Foreground-fetch -- When the application is in foreground.
@@ -90,13 +88,13 @@
  *
  *  Following documentation explains how to activate each mode:
  *
- *  #Fetching IAC in foreground :#
+ *  ##Fetching IAC in foreground
  *  In order to retrieve IAC while the application is running, make sure to do the folllowing:
  *
  *  - Create and configure an SMManagerSettingIAC instance accordingly.
  *  - Provide the created SMManagerSettingIAC instance to SMManager before starting the library
  *
- *  #Fetching IAC in background :#
+ *  ##Fetching IAC in background
  *  Initially, this mode has been added as a complementary-option to the foreground-mode.
  *  However, it can be used as a single-fetch-mode if fits best your application's need.
  *
@@ -108,22 +106,19 @@
  *  - Provide the created SMManagerSettingIAC instance to SMManager before starting the library.
  *  - In the application's target, enable the following: Capabilities > Background Modes > Background Fetch
  *  - Implement performFetchWithCompletionHandler: in UIApplication's delegate (under delegate method application:performFetchWithCompletionHandler:)
- *
- *  #SMManager+InAppContent :#
  */
 
 @interface SMManager (InAppContent)
 
-
 /*!
  * Call when SDK has already provided you with a SMInAppContentViewController (of any type : SMInAppContentHTMLViewController , SMInAppContentImageViewController or SMInAppContentURLViewController) and you want to display it in a UIContainerView defined anywhere in your app.
  * @discussion The viewcontroller will take all available space in  the UIContainerView
  * @param smViewController a SMInAppContentViewController
  * @param containerView the UIContainerView in which In App Content will be displayed
  * @param parentViewController the parent UIViewController of your UIContainerView
+ * @see SMInAppContentViewController
  */
--(void) showSMController: (SMInAppContentViewController*)smViewController InContainerView:(UIView*)containerView OfParentViewController:(UIViewController*)parentViewController;
-
+- (void) showSMController:(SMInAppContentViewController*_Nullable)smViewController InContainerView:(UIView*_Nullable)containerView OfParentViewController:(UIViewController*_Nullable)parentViewController;
 
 /*!
   * @abstract This will return an array of In App Contents
@@ -131,8 +126,9 @@
   * @param category NSString the category for which you want your In App Contents
   * @param type An SMInAppContentType - Url, Html or image
   * @return returns an NSArray of SMInAppContentMessage
+  * @see SMInAppContentType
   */
-- (NSArray*) getInAppContentsForCategory:(NSString*)category Type:(SMInAppContentType)type;
+- (NSArray*_Nonnull) getInAppContentsForCategory:(NSString*_Nullable)category Type:(SMInAppContentType)type;
 
 /*!
   * @abstract This will return an array of In App Contents
@@ -141,25 +137,27 @@
   * @param type An SMInAppContentType - Url, Html or image
   * @param max An int
   * @return returns an NSArray of SMInAppContentMessage
+  * @see SMInAppContentType
   */
-- (NSArray*) getInAppContentsForCategory:(NSString*)category Type:(SMInAppContentType)type Max:(int)max;
+- (NSArray*_Nonnull) getInAppContentsForCategory:(NSString*_Nullable)category Type:(SMInAppContentType)type Max:(int)max;
 
 /*!
   * @abstract This method will mark an IAC as viewed, save it in the cache and send the Open event to the server
   * @discussion If the display mode is set to 0 (display once), the IAC will be discarded from the cache and will not be provided to you anymore with getInAppContentsForCategory:Type: or getInAppContentsForCategory:Type:Max:
   * @param inAppContent an SMInAppContentMessage object
-  */
-- (void) setInAppContentAsSeen:(SMInAppContentMessage*)inAppContent;
-
+  * @see SMInAppContentMessage
+ */
+- (void) setInAppContentAsSeen:(SMInAppContentMessage*_Nullable)inAppContent;
 
 /*!
   * @abstract This method must be called whenever a user has clicked on a link that you  manage to display
   * @discussion This will allow the sdk to inform the services that a link has been clicked and to process the action associated with the link
   * @param link a SMLink object
   * @param inAppContent a SMInAppContentMessage object
+  * @see SMLink
+  * @see SMInAppContentMessage
   */
-- (void) executeLinkAction:(SMLink*)link InAppContent:(SMInAppContentMessage*)inAppContent;
-
+- (void) executeLinkAction:(SMLink*_Nullable)link InAppContent:(SMInAppContentMessage*_Nullable)inAppContent;
 
 /**
  *  This will allow the SDK to fetch the IAC when the OS will allow so.
@@ -167,7 +165,6 @@
  *  @param completionHandler The block-completion to be processed. Provided by the delegate call
  *  @warning Make sure to enable background-fetch in the application's capabilities
  */
-- (void)performIACFetchWithCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler;
-
+- (void) performIACFetchWithCompletionHandler:(void (^_Nullable)(UIBackgroundFetchResult))completionHandler;
 
 @end

package/ios/include/SMManager+InAppMessage.h

@@ -17,7 +17,6 @@
 @class WKNavigationDelegate;
 
 /*!
- *  #Introduction :#
  *  In-Application-Message (IAM) is an optional service which will **automatically** retrieve messages from the back-end at specific frequencies.
  *  Once new messages were retrieved, the library notifies the application about it.
  *  Then, the application may display any IAM as a usual notification.
@@ -27,7 +26,7 @@
  *  Remote-push-notificaitons are almost live messages that are pushed to devices.
  *  While IAM are non-live-messages that the SDK fetch at specific intervals according to provided fetch-mode.
  *
- *  #Implementation :#
+ *  ##Implementation:
  *  In a nutshell, activate the IAM-service is a two steps process:
  *
  *  *   First, create an SMManagerSettingIAM instance and inject it in SMManagerSetting with [SMManagerSetting configureInAppMessageServiceWithSetting:]
@@ -41,7 +40,7 @@
  *  This notification will provide you with the IAM's unique ID.
  *  Please be aware that it’s the unique application’s chance to capture and store that information.
  *
- *  #Displaying IAM :#
+ *  ##Displaying IAM
  *
  *  As IAM and remote-notification share the same format, they are both displayed using the same APIs.
  *  Please read the documentation in SMManager(RemoteNotification) to know how to display any kind of notification.
@@ -51,7 +50,7 @@
  *  Once a SMInAppMessage has been displayed and has been seen by the user you need to call setInAppMessageAsSeen: to inform Selligent that the In App message has been opened
  *  In case there is links in the In App Message and in case one of the link is triggered by user please call executeLinkAction:: to process teh action related to the link and inform Selligent that the link has been clicked
  *
- *  #Fetching modes :#
+ *  ##Fetching modes
  *  IAM may be retrieved from two different modes corresponding to the application's state:
  *
  *  * Foreground-fetch -- When the application is in foreground.
@@ -63,14 +62,14 @@
  *
  *  Following documentation explains how to activate each mode:
  *
- *  #Fetching IAM in foreground :#
+ *  ##Fetching IAM in foreground
  *  In order to retrieve IAM while the application is running, make sure to do the folllowing:
  *
  *  - Create and configure an SMManagerSettingIAM instance accordingly.
  *  - Provide the created SMManagerSettingIAM instance to SMManager before starting the library
  *  - Enable In App message by calling enableInAppMessage: when your application needs it.
  *
- *  #Fetching IAM in background :#
+ *  ##Fetching IAM in background
  *  Initially, this mode has been added as a complementary-option to the foreground-mode.
  *  However, it can be used as a single-fetch-mode if fits best your application's need.
  *  
@@ -83,8 +82,6 @@
  *  - In the application's target, enable the following: Capabilities > Background Modes > Background Fetch
  *  - Implement performFetchWithCompletionHandler: in UIApplicaiton's delegate (under delegate method application:performFetchWithCompletionHandler:)
  *  - Enable In App message by calling enableInAppMessage: when your application needs it.
- *
- *  #SMManager+InAppMessage :#
  */
 @interface SMManager (InAppMessage)
 
@@ -99,9 +96,7 @@
  *  *   Configure correctly the IAM-service via [configureInAppMessageServiceWithSetting:]([SMManagerSetting configureInAppMessageServiceWithSetting:])
  *
  */
-- (void)enableInAppMessage:(BOOL)shouldEnable;
-
-
+- (void) enableInAppMessage:(BOOL)shouldEnable;
 
 /**
  *  This will allow the SDK to fetch the IAM when the OS will allow so.
@@ -109,63 +104,69 @@
  *  @param completionHandler The block-completion to be processed. Provided by the delegate call
  *  @warning Make sure to enable background-fetch in the application's capabilities
  */
-- (void)performIAMFetchWithCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler;
+- (void) performIAMFetchWithCompletionHandler:(void (^_Nullable)(UIBackgroundFetchResult))completionHandler;
 
 /*!
  * @abstract This will return an array of In App Messages
  * @discussion All the valid IAM will be retrieved even if they were already provided to the device
  * @return returns an NSArray of SMInAppMessage
  */
-- (NSArray*) getInAppMessages;
+- (NSArray*_Nonnull) getInAppMessages;
 
 /*!
  * @abstract This method will mark an IAM as viewed, send the Open event to the server and update  SMInAppMessage object in cache with isViewed property set to  true
  * @discussion The message will  still be provided to the device with the flag isViewed set to true
  * @param inAppMessage an SMInAppMessage object
+ * @see SMInAppMessage
  */
-- (void) setInAppMessageAsSeen:(SMInAppMessage*)inAppMessage;
+- (void) setInAppMessageAsSeen:(SMInAppMessage*_Nullable)inAppMessage;
 
 /*!
  * @abstract This method will mark an IAM as unseen
  * @discussion The message will be  provided to the device with the flag isViewed set to false
  * @param inAppMessage an SMInAppMessage object
+ * @see SMInAppMessage
  */
-- (void) setInAppMessageAsUnseen:(SMInAppMessage*)inAppMessage;
+- (void) setInAppMessageAsUnseen:(SMInAppMessage*_Nullable)inAppMessage;
 
 /*!
  * @abstract This method will mark an IAM as deleted
  * @discussion The message will be not be provided again to the device once deleted
  * @param inAppMessage an SMInAppMessage object
+ * @see SMInAppMessage
  */
-- (void) setInAppMessageAsDeleted:(SMInAppMessage*)inAppMessage;
+- (void) setInAppMessageAsDeleted:(SMInAppMessage*_Nullable)inAppMessage;
 
 /*!
  * @abstract This method must be called whenever a user has clicked on a link that you  manage to display
  * @discussion This will allow the sdk to inform the services that a link has been clicked and to process the action associated with the link
  * @param link a SMLink object
  * @param inAppMessage  a SMInAppMessage object
+ * @see SMLink
+ * @see SMInAppMessage
  */
-- (void) executeLinkAction:(SMLink*)link InAppMessage:(SMInAppMessage*)inAppMessage;
+- (void) executeLinkAction:(SMLink*_Nullable)link InAppMessage:(SMInAppMessage*_Nullable)inAppMessage;
 
 /**
  *  @abstract This method will allow you to provide an instance of a class to the sdk . This class will implement the WKNavigationDelegate methods
  *  In this case when the sdk displays an In App Message in a WKWebView you will  for example be able to process the linked click on the app side by implementing  decidePolicyForNavigationAction on the provided class
  *  @param delegate  an object implementing WKNavigationDelegate methods
  */
-- (void) inAppMessageWKNavigationDelegate:(id <WKNavigationDelegate>) delegate;
-
+- (void) inAppMessageWKNavigationDelegate:(id <WKNavigationDelegate>_Nullable) delegate;
 
 /*!
  * @abstract This method must be called whenever a user has clicked on a link that you  manage to display
  * @discussion This will allow the sdk to inform the services that a link has been clicked and to process the action associated with the link
  */
-- (void)removeViewController;
+- (void) removeViewController;
 
 /**
  *  Used to let the app display the inapp message linked to a remote notification
  *  @abstract this setting will allow you to  manage on app side the display of the inapp message linked to a push remote notification
  *  In order to display it in your side the delegate object should implement [SMManagerInAppMessageDelegate displayInAppMessage:] method it will provide tha app with a SMInAppMessage object
  *  @param delegate  an object implementing SMManagerInAppMessageDelegate  methods
+ *  @see SMManagerInAppMessageDelegate
  */
-- (void) inAppMessageDelegate:(id <SMManagerInAppMessageDelegate>) delegate;
+- (void) inAppMessageDelegate:(id <SMManagerInAppMessageDelegate>_Nullable) delegate;
+
 @end

package/ios/include/SMManager+Location.h

@@ -9,11 +9,8 @@
 #import "SMManager.h"
 
 /*!
- *  #Introduction :#
  *  In order to use the location services features provided by the sdk you will mandatory need to use the lsdk library supporting the plotproject framework .
  *  Otherwise calling the method in this SMManager category will have no effect and no ios api related to geofencing will be called (as this is all done by the plot project framework)
- *
- *  #SMManager+Location :#
  */
 @interface SMManager (Location)
 
@@ -24,7 +21,7 @@
  *  If you use plotproject for geolocation it will be mandatory to call it if you have set enableOnFirstRun to false in the plotconfig.json
  *  Call this API according to your application's need.
  */
--(void) enableGeoLocation;
+- (void) enableGeoLocation;
 
 /**
  *  Disable geolocation services
@@ -32,13 +29,13 @@
  *  @discussion This optional call will disable geolocation services at sdk level. it is independent of iOS location authorisation
  *  Call this API according to your application's need.
  */
--(void) disableGeoLocation;
-
+- (void) disableGeoLocation;
 
 /**
- *  check geolocation services status
+ *  Check the geolocation services status
  *
  *  @discussion This optional call will inform you if geolocation services at sdk level are enabled. it is independent of iOS location authorisation
  */
--(BOOL) isGeoLocationEnabled;
+- (BOOL) isGeoLocationEnabled;
+
 @end

package/ios/include/SMManager+Log.h

@@ -7,36 +7,25 @@
 //
 
 #import "SMManager.h"
-
 #import "SMLog.h"
 
-
 /**
  *  This category will help you debug the library.
- *  Please check SMLogLevel for all available possibilities.
- *
  *  Should you want to get back to us, please set logLevel to kSMLogLevel_All and provide with console logs.
- *
- *  #SMManager+Log :#
  */
 @interface SMManager (Log)
 
-
-
 /*!
  *  Set the log level of the library console
  *  @discussion This is an optional setting that may help you debug the library calls.
  *  This call can be done at any time (before or after starting the library).
  *  However, in order to avoid missing any error log, we recommand setting this value before starting the library.
- *  @param logLevel SMLogLevel enumeration type. Default = kSMLoLevel_None
+ *  @param logLevel SMLogLevel enumeration type. Default = kSMLogLevel_None
  *  @warning It is developer's responsability to enable log-level in Debug or release mode. 
  *  No distinction are being aplied by the library.
  *  For obvious performance reason, it is always recommended to turn log off in release mode.
+ *  @see SMLogLevel
  */
-- (void)applyLogLevel:(SMLogLevel)logLevel;
-
-
-
-
+- (void) applyLogLevel:(SMLogLevel)logLevel;
 
 @end