@selligent-marketing-cloud/selligent-react-native 2.4.0 → 2.8.0

package/ios/include/SMEventUserRegistration.h

@@ -9,39 +9,34 @@
 #import "SMEventUser.h"
 
 /*!
- * @class SMEventUserRegistration
- * @inherits SMEventUser
- * @discussion user registration event class
- * #SMEventUserRegistration:#
+ * User registration event class
  */
 @interface SMEventUserRegistration : SMEventUser
 
-
 /*!
  *  Create a UserRegistration event object that will be sent to selligent platform when user registered
  *
- *  @param mail the e-mail of the user
- *  @return a SMEventUserRegistration object
+ *  @param mail The e-mail of the user
+ *  @return An SMEventUserRegistration object
  */
-+ (instancetype _Nonnull)eventWithEmail:(NSString*_Null_unspecified)mail;
++ (instancetype _Nonnull) eventWithEmail:(NSString*_Null_unspecified)mail;
 
 /*!
  *  Create a UserRegistration event object that will be sent to selligent platform when user registered
  *
- *  @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: [SMEventUserRegistration eventWithEmail @"" Dictionary: @{@"userID": @"1234"}];
- *  @return a SMEventUserRegistration object
+ *  @return An SMEventUserRegistration 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 UserRegistration event object that will be sent to platform
- *  @param dict a Dictionary containing an alternate key/value field to search for the user
- *     example: [SMEventUserRegistration eventWithDictionary:@{@"userID": @"1234"}];
- *  @return a SMEventUserRegistration object
+ *  
+ *  @param dict A Dictionary containing an alternate key/value field to search for the user
+ *  @return An SMEventUserRegistration object
  */
-+ (instancetype _Nonnull)eventWithDictionary:(NSDictionary* _Nullable)dict;
++ (instancetype _Nonnull) eventWithDictionary:(NSDictionary* _Nullable)dict;
 
 @end

package/ios/include/SMEventUserUnregistration.h

@@ -9,38 +9,34 @@
 #import "SMEventUser.h"
 
 /*!
- * @class SMEventUserUnregistration
- * @inherits SMEventUser
- * @discussion user unregistration event class
- * #SMEventUserUnregistration:#
+ * User unregistration event class
  */
 @interface SMEventUserUnregistration : SMEventUser
 
 /*!
  *  Create a UserUnregistration event object that will be sent to selligent platform when user unregistered
  *
- *  @param mail the e-mail of the user
- *  @return a SMEventUserUnregistration object
+ *  @param mail The e-mail of the user
+ *  @return An SMEventUserUnregistration object
  */
-+ (instancetype _Nonnull)eventWithEmail:(NSString* _Null_unspecified)mail;
++ (instancetype _Nonnull) eventWithEmail:(NSString* _Null_unspecified)mail;
 
 /*!
  *  Create a UserUnregistration event object that will be sent to selligent platform when user unregistered
  *
- *  @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: [SMEventUserUnregistration eventWithEmail @"" Dictionary: @{@"userID": @"1234"}];
- *  @return a SMEventUserUnregistration object
+ *  @return An SMEventUserUnregistration 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 UserUnregistration event object that will be sent to platform
- *  @param dict a Dictionary containing an alternate key/value field to search for the user
- *     example: [SMEventUserUnregistration eventWithDictionary:@{@"userID": @"1234"}];
- *  @return a SMEventUserUnregistration object
+ *
+ *  @param dict A Dictionary containing an alternate key/value field to search for the user
+ *  @return An SMEventUserUnregistration object
  */
-+ (instancetype _Nonnull)eventWithDictionary:(NSDictionary* _Nullable)dict;
++ (instancetype _Nonnull) eventWithDictionary:(NSDictionary* _Nullable)dict;
 
 @end

package/ios/include/SMFailure.h

@@ -9,15 +9,10 @@
 #import "SMMessage.h"
 
 /*!
- *  @discussion This class is used to return any error
- *  #SMFailure:#
+ *  This class is used to return any error
  */
 @interface SMFailure : SMMessage
 
-
-
-
-
 @end
 
 

package/ios/include/SMHelper.h

@@ -1,17 +1,21 @@
 //
-//  SMHelper.h
+//  SMHelper+Location.h
 //  MobileSDK
 //
-//  Created by Samy Ziat on 29/09/15.
-//  Copyright (c) 2015 Selligent. All rights reserved.
+//  Created by Marc Biosca on 6/29/21.
+//  Copyright © 2021 Selligent. All rights reserved.
 //
 
+#import "SMManager+Location.h"
+#import "SMManagerSetting+Location.h"
 
 #import "SMManagerHelper.h"
 
 #import "SMNSNotification.h"
 #import "SMLink.h"
 #import "SMNotificationButtonData.h"
+#import "SMNotificationAnnotationData.h"
+#import "SMNotificationMessage.h"
 
 #import "SMManagerSetting.h"
 #import "SMManagerSettingIAM.h"
@@ -25,8 +29,12 @@
 #import "SMManager+SilentPush.h"
 #import "SMManager+SMEvent.h"
 #import "SMManager+Log.h"
-#import "SMManager+Location.h"
 #import "SMManager+StyleOptions.h"
+#import "SMManager+ViewController.h"
+#import "SMManager+SMLink.h"
+
+#import "SMManagerInAppMessageDelegate.h"
+#import "SMManagerUniversalLinksDelegate.h"
 
 #import "SMInAppContentImageViewController.h"
 #import "SMInAppContentURLViewController.h"

package/ios/include/SMInAppContentHTMLViewController.h

@@ -10,48 +10,50 @@
 #import "SMInAppContentStyleOptions.h"
 
 /*!
- *  a view controller for HTML In App Content
- *  #SMInAppContentHTMLViewController :#
+ *  A view controller for HTML In App Content
  */
 @interface SMInAppContentHTMLViewController : SMInAppContentViewController
 
-
 /*!
  * This will provide you a custom viewcontroller with all HTML in app content for a specific category
+ *
  * @discussion The viewcontroller will take all available space in screen and will contain a close button if it is presented as it is. Otherwise the app will have to define a UIContainerView which will contain the view controller
  * @param category a NSString of the desired category of In App Content
  * @return a SMInAppContentHTMLViewController
  */
-+ (instancetype) viewControllerForCategory:(NSString*)category ;
++ (instancetype _Nonnull) viewControllerForCategory:(NSString*_Nullable)category ;
 
 /*!
  * This will provide you a custom viewcontroller with all HTML in app content for a specific category
+ *
  * @discussion The viewcontroller will take all available space in screen and will contain a close button if it is presented as it is. Otherwise the app will have to define a UIContainerView which will contain the view controller
  * @param category a NSString of the desired category of In App Content
  * @param options a SMInAppContentStyleOptions object allowing you to customise the in app content
  * @return a SMInAppContentHTMLViewController
+ * @see SMInAppContentStyleOptions
  */
-+ (instancetype) viewControllerForCategory:(NSString*)category AndOptions:(SMInAppContentStyleOptions*)options  ;
++ (instancetype _Nonnull) viewControllerForCategory:(NSString*_Nullable)category AndOptions:(SMInAppContentStyleOptions*_Nullable)options  ;
 
 /*!
  * This will provide you a custom viewcontroller with HTML in app content for a specific category
+ *
  * @discussion The viewcontroller will take all available space in screen and will contain a close button if it is presented as it is. Otherwise the app will have to provide a UIContainerView which will contain the view controller
  * @param category a NSString of the desired category of In App Content
  * @param numberofboxes an int corresponding to the maximum numbers of html boxes that the view controller must contain
  * @return a SMInAppContentHTMLViewController
  */
-+ (instancetype) viewControllerForCategory:(NSString*)category InNumberOfBoxes:(int) numberofboxes ;
-
++ (instancetype _Nonnull) viewControllerForCategory:(NSString*_Nullable)category InNumberOfBoxes:(int) numberofboxes ;
 
 /*!
  * This will provide you a custom viewcontroller with HTML in app content for a specific category
+ *
  * @discussion The viewcontroller will take all available space in screen and will contain a close button if it is presented as it is. Otherwise the app will have to provide a UIContainerView which will contain the view controller
  * @param category a NSString of the desired category of In App Content
  * @param numberofboxes an int corresponding to the maximum numbers of html boxes that the view controller must contain
  * @param options a SMInAppContentStyleOptions object allowing you to customise the in app content
  * @return a SMInAppContentHTMLViewController
+ * @see SMInAppContentStyleOptions
  */
-+ (instancetype) viewControllerForCategory:(NSString*)category InNumberOfBoxes:(int) numberofboxes AndOptions:(SMInAppContentStyleOptions*)options ;
-
++ (instancetype _Nonnull) viewControllerForCategory:(NSString*_Nullable)category InNumberOfBoxes:(int) numberofboxes AndOptions:(SMInAppContentStyleOptions*_Nullable)options ;
 
 @end

package/ios/include/SMInAppContentImageViewController.h

@@ -8,29 +8,29 @@
 
 #import "SMInAppContentViewController.h"
 
-
 /*!
- *  a view controller for Image In App Content
- *  #SMInAppContentImageViewController :#
+ *  A view controller for Image In App Content
  */
 @interface SMInAppContentImageViewController : SMInAppContentViewController
 
 /*!
  * This will provide you a custom viewcontroller with one image view loaded with the url provided by an in app content for a specific category of image type
+ *
  * @discussion The viewcontroller will take all available space in screen and will contain a close button if it is presented as it is. Otherwise the app will have to provide a UIContainerView which will contain the view controller
  * @param category a NSString of the desired category of In App Content
  * @return a SMInAppContentImageViewController
  */
-+ (instancetype) viewControllerForCategory:(NSString*)category;
++ (instancetype _Nonnull) viewControllerForCategory:(NSString*_Nullable)category;
 
 /*!
  * This will provide you a custom viewcontroller with one web view loaded with the url provided by an in app content for a specific category of an Image type
+ *
  * @discussion The viewcontroller will take all available space in screen and will contain a close button if it is presented as it is. Otherwise the app will have to define a UIContainerView which will contain the view controller
  * @param category a NSString of the desired category of In App Content
  * @param options a SMInAppContentStyleOptions object allowing you to customise the in app content
  * @return a SMInAppContentImageViewController
+ * @see SMInAppContentStyleOptions
  */
-+ (instancetype) viewControllerForCategory:(NSString*)category AndOptions:(SMInAppContentStyleOptions*)options  ;
-
++ (instancetype _Nonnull) viewControllerForCategory:(NSString*_Nullable)category AndOptions:(SMInAppContentStyleOptions*_Nullable)options;
 
 @end

package/ios/include/SMInAppContentMessage.h

@@ -11,46 +11,46 @@
 #import "SMInAppContentType.h"
 #import "SMDisplayMode.h"
 
-/*!
- *  #SMInAppContentMessage :#
- */
 @interface SMInAppContentMessage : SMBaseMessage
 
 /*!
  *  NSString instance providing the title of the message
  */
-@property (nonatomic) NSString * title;
+@property (readonly, nonatomic) NSString *_Nullable title;
 
 /*!
  *  NSString instance providing the content of the message
  */
-@property (nonatomic) NSString * body;
+@property (readonly, nonatomic) NSString *_Nullable body;
 
 /*!
  *  NSString instance providing the category of the message
  */
-@property (nonatomic) NSString * category;
+@property (readonly, nonatomic) NSString *_Nullable category;
 
 /*!
  *  SMInAppContentType instance providing the in app content type of the message
+ *  @see SMInAppContentType
  */
-@property (nonatomic) SMInAppContentType  iacType;
+@property (readonly, nonatomic) SMInAppContentType iacType;
 
 /*!
  *  NSDate instance providing the expiration date of the message
- *  @deprecated Deprecated use expirationDate on SMBaseMessage instead
+ *  
+ *  @warning Deprecated - use expirationDate on SMBaseMessage instead
  */
-@property (nonatomic) NSDate   * contentExpiration __deprecated __deprecated_msg("Use expirationDate instead.");
+@property (readonly, nonatomic) NSDate *_Nullable contentExpiration __deprecated __deprecated_msg("Use expirationDate instead.");
 
 /*!
  *  NSDate instance providing the creation date of the message
- *  @deprecated Deprecated use creationDate on SMBaseMessage instead
+ *
+ *  @warning Deprecated - use creationDate on SMBaseMessage instead
  */
-@property (nonatomic) NSDate   * contentCreation __deprecated __deprecated_msg("Use creationDate instead.");
+@property (readonly, nonatomic) NSDate *_Nullable contentCreation __deprecated __deprecated_msg("Use creationDate instead.");
 
 /*!
  *  NSArray of SMLink objects
  */
-@property (nonatomic) NSArray  * arrayIACLinks;
+@property (readonly, nonatomic) NSArray *_Nullable arrayIACLinks;
 
 @end