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

package/ios/include/SMInAppRefreshType.h

@@ -1,29 +0,0 @@
-//
-//  SMIAMRefreshType.h
-//  MobileSDK
-//
-//  Created by Gilbert Schakal on 13/11/15.
-//  Copyright (c) 2015 Selligent. All rights reserved.
-//
-
-/*!
- * 
- */
-typedef NS_ENUM(NSInteger, SMInAppRefreshType) {
-    /*!
-     *  This explicitely disable the In App fetch  mecahnism
-     */
-    kSMIA_RefreshType_None,
-    /*!
-     * Allow to fetch In App Minutely (to be used only in development)
-     */
-    kSMIA_RefreshType_Minutely,
-    /*!
-     * Allow to fetch In App hourly
-     */
-    kSMIA_RefreshType_Hourly,
-    /*!
-     * Allow to fetch In App Daily
-     */
-    kSMIA_RefreshType_Daily ,
-};

package/ios/include/SMLink.h

@@ -1,39 +0,0 @@
-//
-//  SMLinks.h
-//  MobileSDK
-//
-//  Created by Gilbert Schakal on 13/05/16.
-//  Copyright © 2016 Selligent. All rights reserved.
-//
-
-#import <Foundation/Foundation.h>
-#import "SMNotificationButtonType.h"
-
-/**
- *
- */
-@interface SMLink : NSObject
-
-/*!
- *  NSString instance providing the id of the button
- */
-@property (readonly, nonatomic, strong) NSString *_Nullable idButtonData;
-
-/*!
- *  NSString instance providing the label of the button
- */
-@property (readonly, nonatomic, strong) NSString *_Nullable label;
-
-/*!
- *  NSString instance providing the value of the button
- */
-@property (readonly, nonatomic, strong) NSString *_Nullable value;
-
-/*!
- *  The type (SMNotificationButtonType) of action that the button will execute.
- *  
- *  @see SMNotificationButtonType 
- */
-@property (readonly, nonatomic) SMNotificationButtonType type;
-
-@end

package/ios/include/SMLog.h

@@ -1,54 +0,0 @@
-//
-//  SMLog.h
-//  MobileSDK
-//
-//  Created by Gilbert Schakal on 12/06/15.
-//  Copyright (c) 2015 Selligent. All rights reserved.
-//
-
-/*!
- *  Enumeration type for the log granularity
- */
-typedef NS_OPTIONS(NSInteger, SMLogLevel) {
-    /*!
-     *  No log printed at all.
-     *  This is the suggested log-level for release.
-     */
-    kSMLogLevel_None = 0,
-    
-    /*!
-     *  Default log-entry.
-     *  Basically inform user when library starts / ends.
-     */
-    kSMLogLevel_Info = 1 << 1,
-    
-    /*!
-     *  Only warning messages are printed
-     */
-    kSMLogLevel_Warning = 1 << 2,
-    
-    /*!
-     *  Only Error messages are being printed
-     */
-    kSMLogLevel_Error = 1 << 3,
-    
-    /*!
-     *  Print only HTTP-requests stuff
-     */
-    kSMLogLevel_HTTPCall =  1 << 4,
-
-    /*!
-     *  Print only location-requests stuff
-     */
-    kSMLogLevel_Location =  1 << 5,
-    
-    /*!
-     *  Print everything. Do not use for release!!!
-     */
-    kSMLogLevel_All = 0xFF,
-};
-
-
-
-
-

package/ios/include/SMManager+DataTransaction.h

@@ -1,33 +0,0 @@
-//
-//  SMManager+DataTransaction.h
-//  MobileSDK
-//
-//  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.
- */
-@interface SMManager (DataTransaction)
-
-/**
- *  @discussion In order to send device informations to the back-end you can use
- *  @warning Deprecated method
- */
-- (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.
- *  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*_Nullable)deviceInfos;
-
-@end

package/ios/include/SMManager+InAppContent.h

@@ -1,170 +0,0 @@
-//
-//  SMManager+InAppContent.h
-//  MobileSDK
-//
-//  Created by Gilbert Schakal on 11/03/16.
-//  Copyright © 2016 Selligent. All rights reserved.
-//
-
-#import "SMManager.h"
-#import "SMInAppContentType.h"
-#import "SMInAppContentMessage.h"
-#import "SMLink.h"
-
-@class SMInAppContentViewController;
-
-/*!
- *  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
- *
- *  ##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:]
- *
- *  In order to be notified about new IAC, the application must register to correct notification *kSMNotification_Event_DidReceiveInAppContent*
- *  (Please read SMNSNotification for additional information).
- *  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
- *
- *  * With the SDK view controllers:
- *
- *  Each IAC is from a specific type for a specific category.
- *
- *  Selligent SDK provide a specific view controller for each type of in app content
- *
- *   * SMInAppContentHTMLViewController for IAC of type kSMInAppContentType_HTML
- *   * SMInAppContentURLViewController for IAC of type kSMInAppContentType_Url
- *   * SMInAppContentImageViewController for IAC of type kSMInAppContentType_Image
- *
- *  You can check each of this object for more information about how to use them. 
- *  
- *  All this view controller can also be customised with the use of SMInAppContentStyleOptions.
- *
- *  Once the sdk has provided you with the correct view controller
- *
- *      `SMInAppContentURLViewController* vc = [SMInAppContentURLViewController viewControllerForCategory:@"anycategory"];`
- *
- *  You can call showSMController:InContainerView:OfParentViewController: if you expect to display the In App Content in a UIContainerView that is defined in your app :
- *
- *      `[[SMManager sharedInstance] showSMController:vc InContainerView:_containerView OfParentViewController:self];`
- *
- *  Or you can present it to be displayed in full screen mode :
- *
- *       `[self presentViewController:vc animated:YES completion:nil];`
- *
- *  Be aware that if your UIContainerView is defined in storyboard and that no category has been provided to it you will need to inform it with prepareForSegue:sender:
- *
- * ` -(void) prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender
- * {
- *   if ([segue.identifier isEqualToString:@"YourSegue"]) {
- *       _sminappcontentviewcontroller = segue.destinationViewController;
- *       [self.sminappcontentviewcontroller setCategory:@"anycategory"];
- *   }
- * }`
- *
- *  * With your own view controllers
- *
- *  In this case you can call getInAppContentsForCategory:Type: or getInAppContentsForCategory:Type:Max:
- *
- *  Those methods will present you an NSArray of SMInAppContentMessage with all (or a maximum number, precised by the Max parameter) IAC for a category and for a type.
- *
- *  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
- *  IAC may be retrieved from two different modes corresponding to the application's state:
- *
- *  * Foreground-fetch -- When the application is in foreground.
- *  * Background-fetch -- When the application is in background.
- *
- *  Each of these modes is **optional**. In other words, you can use one mode or the other, or even both at the same time.
- *  Choosing the adequate mode depends on the application's need and can be managed by the application's developper.
- *  Off course, to allow the SDK to retrieve IAC as fast as possible, we recommand using both modes at the same time.
- *
- *  Following documentation explains how to activate each mode:
- *
- *  ##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
- *  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.
- *
- *  To understand better how often the OS will execute the background-fetch, make sure to read the following [Apple-documentation](https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/BackgroundExecution/BackgroundExecution.html#//apple_ref/doc/uid/TP40007072-CH4-SW56)
- *
- *  In order to support this mode, make sure to :
- *
- *  - Create the SMManagerSettingIAC instance accordingly.
- *  - 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:)
- */
-
-@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*_Nullable)smViewController InContainerView:(UIView*_Nullable)containerView OfParentViewController:(UIViewController*_Nullable)parentViewController;
-
-/*!
-  * @abstract This will return an array of In App Contents
-  * @discussion All the IAC will be retrieved
-  * @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*_Nonnull) getInAppContentsForCategory:(NSString*_Nullable)category Type:(SMInAppContentType)type;
-
-/*!
-  * @abstract This will return an array of In App Contents
-  * @discussion This overload allows you to define the max number of IAC to retrieve
-  * @param category An NSString the category for which you want your In App Contents
-  * @param type An SMInAppContentType - Url, Html or image
-  * @param max An int
-  * @return returns an NSArray of SMInAppContentMessage
-  * @see SMInAppContentType
-  */
-- (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
-  * @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*_Nullable)link InAppContent:(SMInAppContentMessage*_Nullable)inAppContent;
-
-/**
- *  This will allow the SDK to fetch the IAC when the OS will allow so.
- *  @discussion To be included in application:performFetchWithCompletionHandler:
- *  @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 (^_Nullable)(UIBackgroundFetchResult))completionHandler;
-
-@end

package/ios/include/SMManager+InAppMessage.h

@@ -1,172 +0,0 @@
-//
-//  SMManager+InAppMessage.h
-//  MobileSDK
-//
-//  Created by Samy Ziat on 30/09/15.
-//  Copyright (c) 2015 Selligent. All rights reserved.
-//
-
-#import <WebKit/WebKit.h>
-
-#import "SMManager.h"
-#import "SMInAppMessage.h"
-#import "SMLink.h"
-#import "SMManagerInAppMessageDelegate.h"
-
-@class SMManagerSettingIAM;
-@class WKNavigationDelegate;
-
-/*!
- *  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.
- *
- *  The retrieved IAM share the exact same format as the remote-notification.
- *  However, they are not live messages and, therefore should NOT be considered as an alternative to remote-notification.
- *  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:
- *  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:]
- *  *   Then, enable the IAM-service with enableInAppMessage:
- *
- *  However, additional steps might be required according to desired fetching-mode. 
- *  Each of these steps are explained in further details bellow.
- *
- *  In order to be notified about new IAM, the application must register to correct notification *kSMNotification_Event_DidReceiveInAppMessage*
- *  (Please read SMNSNotification for additional information).
- *  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
- *
- *  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.
- *
- *  Since sdk v 2.5 you have the possibility to store the In App Message on your side and process them the way you want
- *  In order to do that, once you are notified that In App Messages are available you can call getInAppMessages to receive a NSArray of SMInAppMessage
- *  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 the action related to the link and inform Selligent that the link has been clicked
- *
- *  ##Fetching modes
- *  IAM may be retrieved from two different modes corresponding to the application's state:
- *
- *  * Foreground-fetch -- When the application is in foreground.
- *  * Background-fetch -- When the application is in background.
- *
- *  Each of these modes is **optional**. In other words, you can use one mode or the other, or even both at the same time.
- *  Choosing the adequate mode depends on the application's need and can be managed by the application's developper.
- *  Off course, to allow the SDK to retrieve IAM as fast as possible, we recommand using both modes at the same time.
- *
- *  Following documentation explains how to activate each mode:
- *
- *  ##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
- *  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.
- *  
- *  To understand better how often the OS will execute the background-fetch, make sure to read the following [Apple-documentation](https://developer.apple.com/library/ios/documentation/iPhone/Conceptual/iPhoneOSProgrammingGuide/BackgroundExecution/BackgroundExecution.html#//apple_ref/doc/uid/TP40007072-CH4-SW56)
- *
- *  In order to support this mode, make sure to :
- *
- *  - Create the SMManagerSettingIAM instance accordingly.
- *  - Provide the created SMManagerSettingIAM instance to SMManager before starting the library.
- *  - 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.
- */
-@interface SMManager (InAppMessage)
-
-/**
- *  Call this API in order to enable / disable the IAM-service according to your application's need.
- *  @param shouldEnable TRUE will enable IAM. FALSE will disable it.
- *  @discussion Most application will call this API right after starting the SDK.
- *  However, it make no harm to call it later on when user trigger, for instance, a UISwitch.
- *  @warning Before enabling IAM-service, make sure to :
- *
- *  *   Start the SDK. Enabling the IAM-service before starting the SDK will have no effect.
- *  *   Configure correctly the IAM-service via [configureInAppMessageServiceWithSetting:]([SMManagerSetting configureInAppMessageServiceWithSetting:])
- *
- */
-- (void) enableInAppMessage:(BOOL)shouldEnable;
-
-/**
- *  This will allow the SDK to fetch the IAM when the OS will allow so.
- *  @discussion To be included in application:performFetchWithCompletionHandler:
- *  @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 (^_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*_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*_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*_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*_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*_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>_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;
-
-/**
- *  Used to let the app display the in-app message linked to a remote notification
- *  @abstract this setting will allow you to  manage on app side the display of the in-app 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>_Nullable) delegate;
-
-@end

package/ios/include/SMManager+Location.h

@@ -1,41 +0,0 @@
-//
-//  SMManager+Location.h
-//  MobileSDK
-//
-//  Created by Samy Ziat on 02/12/15.
-//  Copyright © 2015 Selligent. All rights reserved.
-//
-
-#import "SMManager.h"
-
-/*!
- *  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)
- */
-@interface SMManager (Location)
-
-/**
- *  Enable geolocation services
- *
- *  @discussion This optional call will enable geolocation services at sdk level. it is independent of iOS location authorisation
- *  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;
-
-/**
- *  Disable geolocation services
- *
- *  @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;
-
-/**
- *  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;
-
-@end

package/ios/include/SMManager+Log.h

@@ -1,31 +0,0 @@
-//
-//  SMManager+SMLog.h
-//  MobileSDK
-//
-//  Created by Samy Ziat on 29/09/15.
-//  Copyright (c) 2015 Selligent. All rights reserved.
-//
-
-#import "SMManager.h"
-#import "SMLog.h"
-
-/**
- *  This category will help you debug the library.
- *  Should you want to get back to us, please set logLevel to kSMLogLevel_All and provide with console logs.
- */
-@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 = 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;
-
-@end