Replaced UIUserNotificationSettings deprecated APIs. Supported Azure notification hub template.

Author: phongcao

docs/ios-installation.md

@@ -9,7 +9,7 @@ react-native init ReactNativeAzureNotificationHubSample
 ```
 
 In addition to the standard React Native requirements, you will also need the following:
-* An iOS 9 (or later version)-capable device (simulator doesn't work with push notifications)
+* An iOS 10 (or later version)-capable device (simulator doesn't work with push notifications)
 * [Apple Developer Program](https://developer.apple.com/programs/) membership
 
 ## Install react-native-azurenotificationhub
@@ -156,34 +156,44 @@ Add the following line to your `ios/Podfile` file and run **pod install**
 * And then add the following code in the same file:
 
 ```objective-c
-// Required to register for notifications
-- (void)application:(UIApplication *)application didRegisterUserNotificationSettings:(UIUserNotificationSettings *)notificationSettings
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
-    [RCTAzureNotificationHubManager didRegisterUserNotificationSettings:notificationSettings];
+    ...
+
+    // Registering for local notifications
+    [[UNUserNotificationCenter currentNotificationCenter] setDelegate:self];
+
+    return YES;
 }
 
-// Required for the register event.
+// Invoked when the app successfully registered with Apple Push Notification service (APNs).
 - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 {
     [RCTAzureNotificationHubManager didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
 }
 
-// Required for the registrationError event.
+// Invoked when APNs cannot successfully complete the registration process.
 - (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
 {
     [RCTAzureNotificationHubManager didFailToRegisterForRemoteNotificationsWithError:error];
 }
 
-// Required for the notification event.
-- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)notification
+// Invoked when a remote notification arrived and there is data to be fetched.
+- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo
+fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler
 {
-    [RCTAzureNotificationHubManager didReceiveRemoteNotification:notification];
+    [RCTAzureNotificationHubManager didReceiveRemoteNotification:userInfo
+                                          fetchCompletionHandler:completionHandler];
 }
 
-// Required for the localNotification event.
-- (void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification
+// Invoked when a notification arrived while the app was running in the foreground.
+- (void)userNotificationCenter:(UNUserNotificationCenter *)center
+       willPresentNotification:(UNNotification *)notification
+         withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler
 {
-    [RCTAzureNotificationHubManager didReceiveLocalNotification:notification];
+    [RCTAzureNotificationHubManager userNotificationCenter:center
+                                   willPresentNotification:notification
+                                     withCompletionHandler:completionHandler];
 }
 ```
 
@@ -221,9 +231,12 @@ import {
 
 const NotificationHub = require('react-native-azurenotificationhub/index.ios');
 
-const connectionString = '...'; // The Notification Hub connection string
-const hubName = '...';          // The Notification Hub name
-const tags = [ ... ];           // The set of tags to subscribe to
+const connectionString = '...';       // The Notification Hub connection string
+const hubName = '...';                // The Notification Hub name
+const tags = [ ... ];                 // The set of tags to subscribe to
+const template = '...';               // Notification hub templates:
+                                      // https://docs.microsoft.com/en-us/azure/notification-hubs/notification-hubs-templates-cross-platform-push-messages
+const templateName = '...';           // The template's name
 
 let remoteNotificationsDeviceToken = '';  // The device token registered with APNS
 
@@ -267,15 +280,33 @@ export default class App extends Component {
     // rejects, or if the permissions were previously rejected. The promise
     // resolves to the current state of the permission of 
     // {alert: boolean, badge: boolean,sound: boolean }
-    NotificationHub.requestPermissions();
+    NotificationHub.requestPermissions()
+      .then((res) => console.warn(res))
+      .catch(reason => console.warn(reason));
   }
 
   register() {
-    NotificationHub.register(remoteNotificationsDeviceToken, {connectionString, hubName, tags});
+    NotificationHub.register(remoteNotificationsDeviceToken, { connectionString, hubName, tags })
+      .then((res) => console.warn(res))
+      .catch(reason => console.warn(reason));
+  }
+
+  registerTemplate() {
+    NotificationHub.registerTemplate(remoteNotificationsDeviceToken, { connectionString, hubName, tags, templateName, template })
+      .then((res) => console.warn(res))
+      .catch(reason => console.warn(reason));
   }
 
   unregister() {
-    NotificationHub.unregister();
+    NotificationHub.unregister()
+      .then((res) => console.warn(res))
+      .catch(reason => console.warn(reason));
+  }
+
+  unregisterTemplate() {
+    NotificationHub.unregisterTemplate(templateName)
+      .then((res) => console.warn(res))
+      .catch(reason => console.warn(reason));
   }
 
   render() {
@@ -295,13 +326,27 @@ export default class App extends Component {
            </Text> 
          </View>
        </TouchableOpacity>
+       <TouchableOpacity onPress={this.registerTemplate.bind(this)}>
+         <View style={styles.button}>
+           <Text style={styles.buttonText}>
+             Register Template
+           </Text>
+         </View>
+       </TouchableOpacity>
        <TouchableOpacity onPress={this.unregister.bind(this)}>
          <View style={styles.button}>
            <Text style={styles.buttonText}>
              Unregister
            </Text> 
          </View>
        </TouchableOpacity>
+       <TouchableOpacity onPress={this.unregisterTemplate.bind(this)}>
+         <View style={styles.button}>
+           <Text style={styles.buttonText}>
+             Unregister Template
+           </Text>
+         </View>
+       </TouchableOpacity>
       </View>
     );
   }

ios/AzureNotificationHubIOS.js

@@ -357,12 +357,20 @@ class AzureNotificationHubIOS {
     RCTAzureNotificationHubManager.checkPermissions(callback);
   }
 
-  static register(deviceToken, config) {
-    RCTAzureNotificationHubManager.register(deviceToken, config);
+  static register(deviceToken, config): Promise<string | Object> {
+    return RCTAzureNotificationHubManager.register(deviceToken, config);
   }
 
-  static unregister() {
-    RCTAzureNotificationHubManager.unregister();
+  static registerTemplate(deviceToken, config): Promise<string | Object> {
+    return RCTAzureNotificationHubManager.registerTemplate(deviceToken, config);
+  }
+
+  static unregister(): Promise<string | Object> {
+    return RCTAzureNotificationHubManager.unregister();
+  }
+
+  static unregisterTemplate(templateName): Promise<string | Object> {
+    return RCTAzureNotificationHubManager.unregisterTemplate(templateName);
   }
 
   /**

ios/RCTAzureNotificationHubManager/RCTAzureNotificationHandler.h

@@ -35,9 +35,6 @@
 // Handle registration error for Azure Notification Hub
 - (void)azureNotificationHubRegisteredError:(nonnull NSNotification *)notification;
 
-// Handle successful registration for UIUserNotificationSettings
-- (void)userNotificationSettingsRegistered:(nonnull NSNotification *)notification;
-
 @end
 
 #endif /* RCTAzureNotificationHandler_h */

ios/RCTAzureNotificationHubManager/RCTAzureNotificationHandler.m

@@ -10,8 +10,6 @@
 #import "RCTAzureNotificationHub.h"
 #import "RCTAzureNotificationHandler.h"
 
-extern RCTPromiseResolveBlock requestPermissionsResolveBlock;
-
 @implementation RCTAzureNotificationHandler
 {
 @private
@@ -92,24 +90,4 @@ - (void)azureNotificationHubRegisteredError:(nonnull NSNotification *)notificati
                                 body:errorDetails];
 }
 
-// Handle successful registration for UIUserNotificationSettings
-- (void)userNotificationSettingsRegistered:(nonnull NSNotification *)notification
-{
-    RCTPromiseResolveBlock resolve = notification.userInfo[RCTUserInfoResolveBlock];
-    if (resolve == nil)
-    {
-        return;
-    }
-    
-    UIUserNotificationSettings *notificationSettings = notification.userInfo[RCTUserInfoNotificationSettings];
-    NSDictionary *notificationTypes = @{
-        RCTNotificationTypeAlert: @((notificationSettings.types & UIUserNotificationTypeAlert) > 0),
-        RCTNotificationTypeSound: @((notificationSettings.types & UIUserNotificationTypeSound) > 0),
-        RCTNotificationTypeBadge: @((notificationSettings.types & UIUserNotificationTypeBadge) > 0),
-    };
-    
-    resolve(notificationTypes);
-    requestPermissionsResolveBlock = nil;
-}
-
 @end

ios/RCTAzureNotificationHubManager/RCTAzureNotificationHub.h

@@ -10,6 +10,8 @@
 #ifndef RCTAzureNotificationHub_h
 #define RCTAzureNotificationHub_h
 
+@import UserNotifications;
+
 // Notification Hub events
 extern NSString *const RCTLocalNotificationReceived;
 extern NSString *const RCTRemoteNotificationReceived;
@@ -23,9 +25,10 @@ extern NSString *const RCTUserNotificationSettingsRegistered;
 extern NSString *const RCTConnectionStringKey;
 extern NSString *const RCTHubNameKey;
 extern NSString *const RCTTagsKey;
+extern NSString *const RCTTemplateNameKey;
+extern NSString *const RCTTemplateKey;
 
 // User info
-extern NSString *const RCTUserInfoNotificationSettings;
 extern NSString *const RCTUserInfoDeviceToken;
 extern NSString *const RCTUserInfoRemote;
 extern NSString *const RCTUserInfoResolveBlock;
@@ -38,15 +41,25 @@ extern NSString *const RCTNotificationTypeBadge;
 extern NSString *const RCTNotificationTypeSound;
 extern NSString *const RCTNotificationTypeAlert;
 
+// Messages
+extern NSString *const RCTPromiseResolveUnregiseredSuccessfully;
+
 // Errors
 extern NSString *const RCTErrorUnableToRequestPermissions;
-extern NSString *const RCTErrorUnableToRequestPermissionsDetails;
+extern NSString *const RCTErrorUnableToRequestPermissionsAppExt;
 extern NSString *const RCTErrorUnableToRequestPermissionsTwice;
+extern NSString *const RCTErrorUnableToRequestPermissionsUserReject;
 extern NSString *const RCTErrorInvalidArguments;
 extern NSString *const RCTErrorMissingConnectionString;
 extern NSString *const RCTErrorMissingHubName;
+extern NSString *const RCTErrorMissingTemplateName;
+extern NSString *const RCTErrorMissingTemplate;
+extern NSString *const RCTErrorUnableToUnregister;
+extern NSString *const RCTErrorUnableToUnregisterNoRegistration;
 
-// Completion type used in Azure Notification Hub's native methods
+// Completion types
 typedef void (^RCTNativeCompletion)(NSError *error);
+typedef void (^RCTNotificationCompletion)(BOOL granted, NSError * _Nullable error);
+typedef void (^RCTNotificationSettingsCompletion)(UNNotificationSettings * _Nonnull settings);
 
 #endif /* RCTAzureNotificationHub_h */

ios/RCTAzureNotificationHubManager/RCTAzureNotificationHub.m

@@ -20,9 +20,10 @@
 NSString *const RCTConnectionStringKey                          = @"connectionString";
 NSString *const RCTHubNameKey                                   = @"hubName";
 NSString *const RCTTagsKey                                      = @"tags";
+NSString *const RCTTemplateNameKey                              = @"templateName";
+NSString *const RCTTemplateKey                                  = @"template";
 
 // User info
-NSString *const RCTUserInfoNotificationSettings                 = @"notificationSettings";
 NSString *const RCTUserInfoDeviceToken                          = @"deviceToken";
 NSString *const RCTUserInfoRemote                               = @"remote";
 NSString *const RCTUserInfoResolveBlock                         = @"resolveBlock";
@@ -35,10 +36,18 @@
 NSString *const RCTNotificationTypeSound                        = @"sound";
 NSString *const RCTNotificationTypeAlert                        = @"alert";
 
+// Messages
+NSString *const RCTPromiseResolveUnregiseredSuccessfully        = @"Unregisted successfully";
+
 // Errors
 NSString *const RCTErrorUnableToRequestPermissions              = @"Unabled to request permissions";
-NSString *const RCTErrorUnableToRequestPermissionsDetails       = @"Requesting push notifications is currently unavailable in an app extension";
+NSString *const RCTErrorUnableToRequestPermissionsAppExt        = @"Requesting push notifications is currently unavailable in an app extension.";
 NSString *const RCTErrorUnableToRequestPermissionsTwice         = @"Cannot call requestPermissions twice before the first has returned.";
+NSString *const RCTErrorUnableToRequestPermissionsUserReject    = @"User didn't allow permissions.";
 NSString *const RCTErrorInvalidArguments                        = @"Invalid arguments";
 NSString *const RCTErrorMissingConnectionString                 = @"Connection string cannot be null.";
 NSString *const RCTErrorMissingHubName                          = @"Hub name cannot be null.";
+NSString *const RCTErrorMissingTemplateName                     = @"Template name cannot be null.";
+NSString *const RCTErrorMissingTemplate                         = @"Template cannot be null.";
+NSString *const RCTErrorUnableToUnregister                      = @"Unabled to unregister";
+NSString *const RCTErrorUnableToUnregisterNoRegistration        = @"There is no registration.";

ios/RCTAzureNotificationHubManager/RCTAzureNotificationHubManager.h

@@ -9,22 +9,26 @@
 
 #import "React/RCTEventEmitter.h"
 
-@interface RCTAzureNotificationHubManager : RCTEventEmitter
+#import "RCTAzureNotificationHandler.h"
+
+@import UserNotifications;
 
-// Required to register for notifications, invoked from AppDelegate
-+ (void)didRegisterUserNotificationSettings:(nonnull UIUserNotificationSettings *)notificationSettings;
+@interface RCTAzureNotificationHubManager : RCTEventEmitter
 
-// Required for the register event, invoked from AppDelegate
+// Invoked from AppDelegate when the app successfully registered with Apple Push Notification service (APNs).
 + (void)didRegisterForRemoteNotificationsWithDeviceToken:(nonnull NSData *)deviceToken;
 
-// Required for the notification event, invoked from AppDelegate
-+ (void)didReceiveRemoteNotification:(nonnull NSDictionary *)notification;
+// Invoked from AppDelegate when APNs cannot successfully complete the registration process.
++ (void)didFailToRegisterForRemoteNotificationsWithError:(nonnull NSError *)error;
 
-// Required for the localNotification event, invoked from AppDelegate
-+ (void)didReceiveLocalNotification:(nonnull UILocalNotification *)notification;
+// Invoked from AppDelegate when a remote notification arrived and there is data to be fetched.
++ (void)didReceiveRemoteNotification:(nonnull NSDictionary *)userInfo
+              fetchCompletionHandler:(void (__unused ^_Nonnull)(UIBackgroundFetchResult result))completionHandler;
 
-// Required for the registrationError event, invoked from AppDelegate
-+ (void)didFailToRegisterForRemoteNotificationsWithError:(nonnull NSError *)error;
+// Invoked from AppDelegate when a notification arrived while the app was running in the foreground.
++ (void)userNotificationCenter:(nonnull __unused UNUserNotificationCenter *)center
+       willPresentNotification:(nonnull UNNotification *)notification
+         withCompletionHandler:(void (__unused ^_Nonnull)(UNNotificationPresentationOptions options))completionHandler;
 
 // Set application icon badge number
 - (void)setApplicationIconBadgeNumber:(NSInteger)number;
@@ -65,11 +69,25 @@
 // Register with Azure Notification Hub
 - (void)register:(nonnull NSString *)deviceToken
           config:(nonnull NSDictionary *)config
-        resolver:(nonnull RCTPromiseResolveBlock)resolve
+        resolver:(nonnull __unused RCTPromiseResolveBlock)resolve
         rejecter:(nonnull RCTPromiseRejectBlock)reject;
 
+// Register template
+- (void)registerTemplate:(nonnull NSString *)deviceToken
+                  config:(nonnull NSDictionary *)config
+                resolver:(nonnull __unused RCTPromiseResolveBlock)resolve
+                rejecter:(nonnull RCTPromiseRejectBlock)reject;
+
 // Unregister with Azure Notification Hub
 - (void)unregister:(nonnull RCTPromiseResolveBlock)resolve
           rejecter:(nonnull RCTPromiseRejectBlock)reject;
 
+// Unregister template
+- (void)unregisterTemplate:(nonnull NSString *)templateName
+                  resolver:(nonnull RCTPromiseResolveBlock)resolve
+                  rejecter:(nonnull RCTPromiseRejectBlock)reject;
+
+// Set notification handler
+- (void)setNotificationHandler:(nonnull RCTAzureNotificationHandler *)handler;
+
 @end