pushwoosh-react-native-plugin 1.2.5 → 2.2.17

package/src/ios/PushNotificationManager.h

@@ -5,12 +5,25 @@
 //
 
 #import <Foundation/Foundation.h>
+
+#if TARGET_OS_IOS
+
 #import <UIKit/UIKit.h>
 #import <StoreKit/StoreKit.h>
 
+#endif
+
+
 @class PushNotificationManager;
+
+#if TARGET_OS_IOS || TARGET_OS_WATCH
+
+#import <UserNotifications/UserNotifications.h>
+
 @class CLLocation;
 
+#endif
+
 typedef void (^PushwooshGetTagsHandler)(NSDictionary *tags);
 typedef void (^PushwooshErrorHandler)(NSError *error);
 
@@ -18,6 +31,8 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  `PushNotificationDelegate` protocol defines the methods that can be implemented in the delegate of the `PushNotificationManager` class' singleton object.
  These methods provide information about the key events for push notification manager such as registering with APS services, receiving push notifications or working with the received notification.
  These methods implementation allows to react on these events properly.
+ 
+ Deprecated. Use PWMessagingDelegate instead.
  */
 @protocol PushNotificationDelegate
 
@@ -39,12 +54,10 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 /**
  Tells the delegate that the push manager has received a remote notification.
  
- If this method is implemented `onPushAccepted:withNotification:` will not be called, internal message boxes will not be displayed.
- 
  @param pushManager The push manager that received the remote notification.
  @param pushNotification A dictionary that contains information referring to the remote notification, potentially including a badge number for the application icon, an alert sound, an alert message to display to the user, a notification identifier, and custom data.
  The provider originates it as a JSON-defined dictionary that iOS converts to an NSDictionary object; the dictionary may contain only property-list objects plus NSNull.
- @param onStart If the application was not active when the push notification was received, the application will be launched with this parameter equal to `YES`, otherwise the parameter will be `NO`.
+@param onStart If the application was not foreground when the push notification was received, the application will be opened with this parameter equal to `YES`, otherwise the parameter will be `NO`.
  */
 - (void)onPushReceived:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart;
 
@@ -56,35 +69,44 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  @param pushNotification A dictionary that contains information referring to the remote notification, potentially including a badge number for the application icon, an alert sound, an alert message to display to the user, a notification identifier, and custom data.
  The provider originates it as a JSON-defined dictionary that iOS converts to an NSDictionary object; the dictionary may contain only property-list objects plus NSNull.
  Push dictionary sample:
- 
-	 {
-		 aps =     {
-			 alert = "Some text.";
-			 sound = default;
-		 };
-		 p = 1pb;
-	 }
- 
+ @code
+ {
+    aps =     {
+        alert = "Some text.";
+        sound = default;
+    };
+    p = 1pb;
+ }
+ @endcode
  */
-- (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification;
+- (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification DEPRECATED_ATTRIBUTE;
 
 /**
- Tells the delegate that the user has pressed OK on the push notification.
+ Tells the delegate that a custom action was triggered when opening a notification.
+ 
+ @param identifier NSString containing an ID of a clicked button. This ID is set by a user when creating a category in the Pushwoosh Control Panel
+ @param notification NSDictionary with push payload. 
+*/
+- (void)onActionIdentifierReceived:(NSString *)identifier withNotification:(NSDictionary *)notification;
+
+/**
+ Tells the delegate that the user has pressed on the push notification banner.
  
  @param pushManager The push manager that received the remote notification.
  @param pushNotification A dictionary that contains information about the remote notification, potentially including a badge number for the application icon, an alert sound, an alert message to display to the user, a notification identifier, and custom data.
  The provider originates it as a JSON-defined dictionary that iOS converts to an NSDictionary object; the dictionary may contain only property-list objects plus NSNull.
  Push dictionary sample:
+ @code
+ {
+     aps =     {
+         alert = "Some text.";
+         sound = default;
+     };
+     p = 1pb;
+ }
+ @endcode
  
-	 {
-		 aps =     {
-			 alert = "Some text.";
-			 sound = default;
-		 };
-		 p = 1pb;
-	 }
- 
- @param onStart If the application was not active when the push notification was received, the application will be launched with this parameter equal to `YES`, otherwise the parameter will be `NO`.
+ @param onStart If the application was not foreground when the push notification was received, the application will be opened with this parameter equal to `YES`, otherwise the parameter will be `NO`.
  */
 - (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart;
 
@@ -93,12 +115,12 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  
  @param tags Dictionary representation of received tags.
  Dictionary example:
- 
-	 {
-		 Country = ru;
-		 Language = ru;
-	 }
- 
+ @code
+ {
+     Country = ru;
+     Language = ru;
+ }
+ @endcode
  */
 - (void)onTagsReceived:(NSDictionary *)tags;
 
@@ -114,19 +136,33 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  
  @param code In-App code
  */
-- (void)onInAppClosed:(NSString *)code;
+- (void)onInAppClosed:(NSString *)code __attribute__((deprecated("Use PWRichMediaPresentingDelegate protocol from PWRichMediaManager.h")));
 
 /**
  Tells the delegate that In-App with specified code has been displayed
  
  @param code In-App code
  */
-- (void)onInAppDisplayed:(NSString *)code;
+- (void)onInAppDisplayed:(NSString *)code __attribute__((deprecated("Use PWRichMediaPresentingDelegate protocol from PWRichMediaManager.h")));
+
+
+#if TARGET_OS_IOS || TARGET_OS_WATCH
+/**
+ The method will be called on the delegate when the application is launched in response to the user's request to view in-app notification settings.
+ Add UNAuthorizationOptionProvidesAppNotificationSettings as an option in [PushNotificationManager pushManager].additionalAuthorizationOptions to add a button to inline notification settings view and the notification settings view in Settings.
+ The notification will be nil when opened from Settings.
+ 
+ @param pushManager PushNotificationManager instance
+ @param notification Source notification
+ */
+- (void)pushManager:(PushNotificationManager *)pushManager openSettingsForNotification:(UNNotification *)notification __IOS_AVAILABLE(12.0);
+
+#endif
 
 @end
 
 /**
-  `PWTags` class encapsulates the methods for creating tags parameters for sending them to the server.
+ `PWTags` class encapsulates the methods for creating tags parameters for sending them to the server.
  */
 @interface PWTags : NSObject
 
@@ -134,14 +170,15 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  Creates a dictionary for incrementing/decrementing a numeric tag on the server.
  
  Example:
+ @code
+ NSDictionary *tags = @{
+     @"Alias" : aliasField.text,
+     @"FavNumber" : @([favNumField.text intValue]),
+     @"price": [PWTags incrementalTagWithInteger:5],
+ };
  
-	NSDictionary *tags = [NSDictionary dictionaryWithObjectsAndKeys:
-							aliasField.text, @"Alias",
-							[NSNumber numberWithInt:[favNumField.text intValue]], @"FavNumber",
-							[PWTags incrementalTagWithInteger:5], @"price",
-							nil];
-
-	[[PushNotificationManager pushManager] setTags:tags];
+ [[PushNotificationManager pushManager] setTags:tags];
+ @endcode
  
  @param delta Difference that needs to be applied to the tag's counter.
  
@@ -149,10 +186,33 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  */
 + (NSDictionary *)incrementalTagWithInteger:(NSInteger)delta;
 
+/**
+ Creates a dictionary for extending Tag’s values list with additional values
+ 
+ Example:
+ 
+ @code
+ NSDictionary *tags = @{
+     @"Alias" : aliasField.text,
+     @"FavNumber" : @([favNumField.text intValue]),
+     @"List" : [PWTags appendValuesToListTag:@[ @"Item1" ]]
+ };
+ 
+ [[PushNotificationManager pushManager] setTags:tags];
+ @endcode
+ 
+ @param array Array of values to be added to the tag.
+ 
+ @return Dictionary to be sent as the value for the tag
+ */
++ (NSDictionary *)appendValuesToListTag:(NSArray<NSString *> *)array;
+
 @end
 
 /**
-  `PushNotificationManager` class offers access to the singletone-instance of the push manager responsible for registering the device with the APS servers, receiving and processing push notifications.
+ `PushNotificationManager` class offers access to the singleton-instance of the push manager responsible for registering the device with the APS servers, receiving and processing push notifications.
+ 
+ Deprecated. Use Pushwoosh class instead.
  */
 @interface PushNotificationManager : NSObject {
 }
@@ -173,19 +233,48 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  */
 @property (nonatomic, weak) NSObject<PushNotificationDelegate> *delegate;
 
+#if TARGET_OS_IOS || TARGET_OS_WATCH
+
 /**
  Show push notifications alert when push notification is received while the app is running, default is `YES`
  */
 @property (nonatomic, assign) BOOL showPushnotificationAlert;
 
+/**
+ Authorization options in addition to UNAuthorizationOptionBadge | UNAuthorizationOptionSound | UNAuthorizationOptionAlert | UNAuthorizationOptionCarPlay.
+ */
+@property (nonatomic) UNAuthorizationOptions additionalAuthorizationOptions __IOS_AVAILABLE(12.0);
+
+#endif
+
 /**
  Returns push notification payload if the app was started in response to push notification or null otherwise
  */
 @property (nonatomic, copy, readonly) NSDictionary *launchNotification;
 
+#if TARGET_OS_IOS || TARGET_OS_WATCH
+
+/**
+ Returns UNUserNotificationCenterDelegate that handles foreground push notifications on iOS10
+ */
+@property (nonatomic, strong, readonly) id<UNUserNotificationCenterDelegate> notificationCenterDelegate;
+
+#elif TARGET_OS_OSX
+
+@property (nonatomic, strong, readonly) id<NSUserNotificationCenterDelegate> notificationCenterDelegate;
+
+#endif
+
+/**
+ Set custom application language. Must be a lowercase two-letter code according to ISO-639-1 standard ("en", "de", "fr", etc.).
+ Device language used by default.
+ Set to nil if you want to use device language again.
+ */
+@property (nonatomic) NSString *language;
+
 /**
  Initializes PushNotificationManager. Usually called by Pushwoosh Runtime internally.
- @param appcCode Pushwoosh App ID.
+ @param appCode Pushwoosh App ID.
  @param appName Application name.
  */
 + (void)initializeWithAppCode:(NSString *)appCode appName:(NSString *)appName;
@@ -204,44 +293,65 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 - (void)registerForPushNotifications;
 
 /**
- Unregisters from push notifications. You should call this method in rare circumstances only, such as when a new version of the app drops support for remote notifications. Users can temporarily prevent apps from receiving remote notifications through the Notifications section of the Settings app. Apps unregistered through this method can always re-register.
+ Unregisters from push notifications.
  */
-- (void)unregisterForPushNotifications;
+- (void)unregisterForPushNotificationsWithCompletion:(void (^)(NSError *error))completion;
 
-- (instancetype)initWithApplicationCode:(NSString *)appCode appName:(NSString *)appName;
-- (id)initWithApplicationCode:(NSString *)appCode navController:(UIViewController *)navController appName:(NSString *)appName __attribute__((deprecated));
+/**
+ Deprecated. Use unregisterForPushNotificationsWithCompletion: method instead
+ */
+- (void)unregisterForPushNotifications __attribute__((deprecated));
 
 /**
- Sends geolocation to the server for GeoFencing push technology. Called internally, please use `startLocationTracking` and `stopLocationTracking` functions.
- 
- @param location Location to be sent.
+ Deprecated. Use initializeWithAppCode:appName: method instead
+ */
+- (instancetype)initWithApplicationCode:(NSString *)appCode appName:(NSString *)appName __attribute__((deprecated));
+
+#if TARGET_OS_IOS
+
+/**
+ Deprecated. Use initializeWithAppCode:appName: method instead
  */
-- (void)sendLocation:(CLLocation *)location;
+- (id)initWithApplicationCode:(NSString *)appCode navController:(UIViewController *)navController appName:(NSString *)appName __attribute__((deprecated));
 
 /**
  Start location tracking.
+ 
+ Deprecated. Use PushwooshGeozones framework.
  */
-- (void)startLocationTracking;
+- (void)startLocationTracking __attribute__((deprecated("Use PushwooshGeozones framework")));
 
 /**
  Stops location tracking
+ 
+ Deprecated. Use PushwooshGeozones framework.
  */
-- (void)stopLocationTracking;
+- (void)stopLocationTracking __attribute__((deprecated("Use PushwooshGeozones framework")));
 
+/**
+ Explicitly sends geolocation to the server for GeoFencing push technology. Also called internally, please use `startLocationTracking` and `stopLocationTracking` functions.
+ 
+ @param location Location to be sent.
+ 
+ Deprecated. Use PushwooshGeozones framework.
+ */
+- (void)sendLocation:(CLLocation *)location __attribute__((deprecated("Use PushwooshGeozones framework")));
+
+#endif
 
 /**
  Send tags to server. Tag names have to be created in the Pushwoosh Control Panel. Possible tag types: Integer, String, Incremental (integer only), List tags (array of values).
  
  Example:
- 
-	 NSDictionary *tags = [NSDictionary dictionaryWithObjectsAndKeys:
-							 aliasField.text, @"Alias",
-							 [NSNumber numberWithInt:[favNumField.text intValue]], @"FavNumber",
-							 [PWTags incrementalTagWithInteger:5], @"price",
-							 [NSArray arrayWithObjects:@"Item1", @"Item2", @"Item3", nil], @"List",
-							 nil];
+ @code
+ NSDictionary *tags =  @{ @"Alias" : aliasField.text,
+                      @"FavNumber" : @([favNumField.text intValue]),
+                          @"price" : [PWTags incrementalTagWithInteger:5],
+                           @"List" : @[ @"Item1", @"Item2", @"Item3" ]
+ };
 	
-	 [[PushNotificationManager pushManager] setTags:tags];
+ [[PushNotificationManager pushManager] setTags:tags];
+ @endcode
  
  @param tags Dictionary representation of tags to send.
  */
@@ -262,12 +372,10 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  
  @param successHandler The block is executed on the successful completion of the request. This block has no return value and takes one argument: the dictionary representation of the recieved tags.
  Example of the dictionary representation of the received tags:
- 
-	 {
-		 Country = ru;
-		 Language = ru;
-	 }
- 
+ {
+     Country = ru;
+     Language = ru;
+ }
  @param errorHandler The block is executed on the unsuccessful completion of the request. This block has no return value and takes one argument: the error that occurred during the request.
  */
 - (void)loadTags:(PushwooshGetTagsHandler)successHandler error:(PushwooshErrorHandler)errorHandler;
@@ -277,27 +385,24 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  */
 - (void)sendAppOpen;
 
-/**
- Sends current badge value to server. Called internally by SDK Runtime when `UIApplication` `setApplicationBadgeNumber:` is set. This function is used for "auto-incremeting" badges to work.
- This way Pushwoosh server can know what current badge value is set for the application.
- 
- @param badge Current badge value.
- */
-- (void)sendBadges:(NSInteger)badge;
++ (NSString *)pushwooshVersion;
 
+#if TARGET_OS_IOS
 /**
  Sends in-app purchases to Pushwoosh. Use in paymentQueue:updatedTransactions: payment queue method (see example).
  
  Example:
- 
-	 - (void)paymentQueue:(SKPaymentQueue *)queue updatedTransactions:(NSArray *)transactions {
-		[[PushNotificationManager pushManager] sendSKPaymentTransactions:transactions];
-	 }
+ @code
+ - (void)paymentQueue:(SKPaymentQueue *)queue updatedTransactions:(NSArray *)transactions {
+     [[PushNotificationManager pushManager] sendSKPaymentTransactions:transactions];
+ }
+ @endcode
  
  @param transactions Array of SKPaymentTransaction items as received in the payment queue.
  */
 - (void)sendSKPaymentTransactions:(NSArray *)transactions;
 
+
 /**
  Tracks individual in-app purchase. See recommended `sendSKPaymentTransactions:` method.
  
@@ -308,6 +413,7 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  */
 - (void)sendPurchase:(NSString *)productIdentifier withPrice:(NSDecimalNumber *)price currencyCode:(NSString *)currencyCode andDate:(NSDate *)date;
 
+#endif
 /**
  Gets current push token.
  
@@ -326,39 +432,40 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 - (void)handlePushRegistration:(NSData *)devToken;
 - (void)handlePushRegistrationString:(NSString *)deviceID;
 
-//internal
 - (void)handlePushRegistrationFailure:(NSError *)error;
 
-//if the push is received while the app is running. internal
+//If the push is received while the app is running. Call it only for iOS version < 10. For iOS 10 and higher use notificationCenterDelegate.
 - (BOOL)handlePushReceived:(NSDictionary *)userInfo;
 
 /**
  Gets APN payload from push notifications dictionary.
  
  Example:
+ @code
+ - (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart {
+     NSDictionary * apnPayload = [[PushNotificationsManager pushManager] getApnPayload:pushNotification];
+     NSLog(@"%@", apnPayload);
+ }
+ @endcode
  
-	 - (void) onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart {
-		NSDictionary * apnPayload = [[PushNotificationsManager pushManager] getApnPayload:pushNotification];
-		NSLog(@"%@", apnPayload);
-	 }
-
  For Push dictionary sample:
+ @code
+ {
+     aps =     {
+         alert = "Some text.";
+         sound = default;
+     };
+     p = 1pb;
+ }
+ @endcode
  
-	 {
-		aps =     {
-			alert = "Some text.";
-			sound = default;
-		};
-		p = 1pb;
-	 }
-
  Result is:
- 
-	 {
-		alert = "Some text.";
-		sound = default;
-	 };
-
+ @code
+ {
+     alert = "Some text.";
+     sound = default;
+ };
+ @endcode
  @param pushNotification Push notifications dictionary as received in `onPushAccepted: withNotification: onStart:`
  */
 - (NSDictionary *)getApnPayload:(NSDictionary *)pushNotification;
@@ -367,11 +474,12 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  Gets custom JSON string data from push notifications dictionary as specified in Pushwoosh Control Panel.
  
  Example:
- 
-	 - (void) onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart {
-		NSString * customData = [[PushNotificationsManager pushManager] getCustomPushData:pushNotification];
-		NSLog(@"%@", customData);
-	 }
+ @code
+ - (void)onPushAccepted:(PushNotificationManager *)pushManager withNotification:(NSDictionary *)pushNotification onStart:(BOOL)onStart {
+     NSString * customData = [[PushNotificationsManager pushManager] getCustomPushData:pushNotification];
+     NSLog(@"%@", customData);
+ }
+ @endcode
  
  @param pushNotification Push notifications dictionary as received in `onPushAccepted: withNotification: onStart:`
  */
@@ -384,7 +492,9 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 
 /**
  Returns dictionary with enabled remove notificaton types.
+ 
  Example enabled push:
+ @code
  {
 	enabled = 1;
 	pushAlert = 1;
@@ -392,10 +502,11 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 	pushSound = 1;
 	type = 7;
  }
- 
+ @endcode
  where "type" field is UIUserNotificationType
  
  Disabled push:
+ @code
  {
 	enabled = 1;
 	pushAlert = 0;
@@ -403,6 +514,7 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 	pushSound = 0;
 	type = 0;
  }
+ @endcode
  
  Note: In the latter example "enabled" field means that device can receive push notification but could not display alerts (ex: silent push)
  */
@@ -416,8 +528,10 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
 /**
  Set User indentifier. This could be Facebook ID, username or email, or any other user ID.
  This allows data and events to be matched across multiple user devices.
+ 
+ Deprecated. Use PWInAppManager setUserId method instead
  */
-- (void)setUserId:(NSString *)userId;
+- (void)setUserId:(NSString *)userId __attribute__ ((deprecated));;
 
 /**
  Move all events from oldUserId to newUserId if doMerge is true. If doMerge is false all events for oldUserId are removed.
@@ -425,27 +539,36 @@ typedef void (^PushwooshErrorHandler)(NSError *error);
  @param oldUserId source user
  @param newUserId destination user
  @param doMerge if false all events for oldUserId are removed, if true all events for oldUserId are moved to newUserId
- @param completeion callback
+ @param completion callback
+ 
+ Deprecated. Use PWInAppManager mergeUserId method instead
  */
-- (void)mergeUserId:(NSString *)oldUserId to:(NSString *)newUserId doMerge:(BOOL)doMerge completion:(void (^)(NSError *error))completion;
+- (void)mergeUserId:(NSString *)oldUserId to:(NSString *)newUserId doMerge:(BOOL)doMerge completion:(void (^)(NSError *error))completion __attribute__ ((deprecated));
 
 /**
  Post events for In-App Messages. This can trigger In-App message display as specified in Pushwoosh Control Panel.
  
  Example:
+ @code
+ [[PushNotificationManager pushManager] setUserId:@"96da2f590cd7246bbde0051047b0d6f7"];
+ [[PushNotificationManager pushManager] postEvent:@"buttonPressed" withAttributes:@{ @"buttonNumber" : @"4", @"buttonLabel" : @"Banner" } completion:nil];
+ @endcode
  
-	 [[PushNotificationManager pushManager] setUserId:@"96da2f590cd7246bbde0051047b0d6f7"];
-	 [[PushNotificationManager pushManager] postEvent:@"buttonPressed" withAttributes:@{ @"buttonNumber" : @"4", @"buttonLabel" : @"Banner" } completion:nil];
-
  @param event name of the event
  @param attributes NSDictionary of event attributes
  @param completion function to call after posting event
+ 
+ Deprecated. Use PWInAppManager postEvent method instead
  */
-- (void)postEvent:(NSString *)event withAttributes:(NSDictionary *)attributes completion:(void (^)(NSError *error))completion;
+- (void)postEvent:(NSString *)event withAttributes:(NSDictionary *)attributes completion:(void (^)(NSError *error))completion __attribute__ ((deprecated));
 
 /**
  See `postEvent:withAttributes:completion:`
+ 
+ Deprecated. Use PWInAppManager postEvent method instead
  */
-- (void)postEvent:(NSString *)event withAttributes:(NSDictionary *)attributes;
+- (void)postEvent:(NSString *)event withAttributes:(NSDictionary *)attributes __attribute__ ((deprecated));
+
++ (BOOL)isPushwooshMessage:(NSDictionary *)userInfo;
 
 @end