iOS SDK

In your AppDelegate, you need to disable swizzling and then only call registerForPushNotifications.

// Your code
    Hclcdp.shared.setSwizzle(state: false)
    Hclcdp.shared.setSwizzleForAll(state: false)
    Hclcdp.shared.registerForPushNotifications()
// Your code

// your code
[[Hclcdp shared] setSwizzleWithState:NO];
[[Hclcdp shared] setSwizzleForAllWithState:NO];
[[Hclcdp shared] registerForPushNotifications];
// your code

After you add above code, you need to call our HCL CDP methods in your UIApplicationDelegate methods as mentioned below:

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    // Your code
    Hclcdp.shared.application(application, didRegisterForRemoteNotificationsWithDeviceToken: deviceToken)
    // Your code
}

func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
    // Your code
    Hclcdp.shared.application(application, didFailToRegisterForRemoteNotificationsWithError: error)
    // Your code
}

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    // Your code
    Hclcdp.shared.application(application, didReceiveRemoteNotification: userInfo, fetchCompletionHandler: completionHandler)
    // Your code
}

// Your code
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    // Your code
    [[Hclcdp shared] application:application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
    // Your code
}

- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {
    // Your code
    [[Hclcdp shared] application:application didFailToRegisterForRemoteNotificationsWithError:error];
    // Your code
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    // Your code
    [[Hclcdp shared] application:application didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
    // Your code
}
// Your code

Notification Service Extension

We use Notification Service Extension to track the delivery of Push Notifications as well as downloading the Rich Media Push Notification attachments (image/video/audio etc)

• Add a Notification Service Extension target to your project (File -> New -> Target -> Notification Service Extension).
• Define the name for the Notification Service Extension in the next step.
• Now please enable the AppGroup capability from our Xcode Signing & Capabilities Tab and use the same AppGroup for all the 3 targets (App, Notification Service Extension and Notification Content Extension). You can find the documentation on how to enable App Groupif you aren't familiar with this.
• Now modify the NotificationService.swift to look like the following code.
• If you are using SDK version below 3.8.5 then use the below code

  import UserNotifications
  import HclcdpRichNotification
  
  class NotificationService: HclcdpNotificationService {
  
      public override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
          super.setAppGroupID(groupId: "your app groupid") // This will be something like co.Hclcdp.app.ios.bankingdemo that you have created above
          super.didReceive(request, withContentHandler: contentHandler)
      }
  
      public override func serviceExtensionTimeWillExpire() {
          super.serviceExtensionTimeWillExpire()
      }
  }

• If you are using version 3.8.5 and above modify the NotificationService.swift to look like the following code.

  import UserNotifications
  //if SDK version <= 3.8.5
  import HclcdpRichNotification
  // else if SDK version >= 3.8.6
  import Hclcdp
  
  class NotificationService: UNNotificationServiceExtension {
      public override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
          HclcdpNotificationService.shared.setAppGroupID(groupId: "your app groupid") // This will be something like co.Hclcdp.app.ios.bankingdemo that you have created above
          HclcdpNotificationService.shared.didReceive(request, withContentHandler: contentHandler)
      }
      
      public override func serviceExtensionTimeWillExpire() {
          super.serviceExtensionTimeWillExpire()
      }
  }

  If you have multiple push providers and using sdk version >= 3.8.6 you can implement NotificationService as mentioned below.

  import UserNotifications
  import Hclcdp
  
  class NotificationService: UNNotificationServiceExtension {
  
      var bestAttemptContent: UNMutableNotificationContent?
      var isHclcdpPush: Bool?
      
      public override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
  
          self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
          self.isHclcdpPush = false
          
          var userInfo: [String: Any]? = bestAttemptContent?.userInfo as? [String: Any]
  
          if Hclcdp.shared.isHclcdpPush(userInfo: userInfo) {
              self.isHclcdpPush = true
              HclcdpNotificationService.shared.setAppGroupID(groupId: "your app groupid")
              HclcdpNotificationService.shared.didReceive(request, withContentHandler: contentHandler)
          }
          else{
              //other push provider code
          }
      }
      
      public override func serviceExtensionTimeWillExpire() {
          if(self.isHclcdpPush == true){
              super.serviceExtensionTimeWillExpire()
          }
          else{
              //other push provider code
          }
      }
  }

This extension can be used if you want to show a carousel slider in a Push Notification.

• Add a Notification Content Extension target to your project (File -> New -> Target -> Notification Content Extension).
• Define the name for the Notification Content Extension in the next step.
• Make sure the deployment target for notification content is set to iOS 10.
• Now enable the AppGroup capability from our Xcode Signing & Capabilities Tab and use the same AppGroup for all the 3 targets (App, Notification Service Extension and Notification Content Extension).
• Modify the NotificationViewController.swift to look like the following code.

  import UIKit
  import UserNotifications
  import UserNotificationsUI
  // if sdk version <= 3.8.5
  import HclcdpNotificationContent
  // else if sdk version >= 3.8.6
  import Hclcdp
  
  class NotificationViewController:  HclcdpNotificationViewController {
  
      override func viewDidLoad() {
          super.viewDidLoad();
      }
  
      override func didReceive(_ notification: UNNotification) {
          super.setAppGroupID(groupId: "your app groupid") // This will be something like co.Hclcdp.app.ios.bankingdemo that you have created above
          super.didReceive(notification)
      }
  }

• Then run pod install. If you are running this for the first time then you may need to update the pod repositories by using running pod install --repo-update. This would install the HCL CDP framework along with the required dependencies for your app extension targets.

Please follow the following procedure if you are using the Xcode Auto Sign, otherwise please scroll below to add the App Groups manually via the Apple Developer Console.

• Go to the Identifiers tab in the Apple Developer Console and click App Groups as shown in the below screenshot.

  

• Now click + to create a new App Group.

  

• Select App Groups on the next screen as shown below.

  

• Now fill the Description and the Identifier (App Group name), and click Continue.

  

• On the next screen, click Register.

  

• Now, go to the Identifiers tab, click your App Bundle identifier.

  

• Check App Groups and click configure.

  

• In the next step, select the group we have created in the previous step and click continue and then Save.

  

• Now go to Profile tab and select your profile, if it shows invalid then click Edit and Save. Then download the file and use it in the Xcode.
• Finally in the Xcode, go to Singing & Capabilities as shown in the following screenshot.

  

• Now search for App group and select App Groups.

  

• Now select the App group that we have created earlier in the Apple Developer Console.

  

• Now repeat steps 6-12 for App extension targets as well (From theNow go to Identifiers step above).

With iOS 15 and iPadOS 15, Focus Mode lets you stay in the moment when you need to concentrate or step away from your device. You can customize Focus settings and choose when you want to receive alerts and notifications, while letting other people and apps know when you’re busy. For more information, refer https://support.apple.com/en-in/HT212608

1. active (default)
   • Active is the default interruption level.
   • Sounds and vibrations can be played and the screen will light up upon delivery.
   • These notifications cannot break through Focus modes.
2. passive
   • Passive notifications are the notifications that do not require immediate attention.
   • No sound or vibration is played when the notification is delivered.
   • Examples for passives are such as restaurant recommendations or upcoming sports game updates.
3. timeSensitive
   • Time sensitive notifications behave similarly to Active notifications.
   • Time Sensitive are displayed with a yellow Time Sensitive banner.
   • These notifications can break through scheduled delivery and Focus modes.
   • Time Sensitive notifications are only be used for notifications that require immediate attention such as an account security or package delivery alerts.
   • To enable Time Sensitive notifications, we need to add the xcode capability to our App in Xcode (Time Sensitive Notifications capability) Users can turn off time sensitive notifications for an app.
4. critical
   • Critical notifications are always delivered immediately and bypass the silent ringer switch.
   • These are only available with an approved entitlement and are used for severe weather and local safety alerts .
   • The interruption level can be set on the UNNotificationContent object or in the APN's payload with key interruption-level at the apps level.
   • Apps are able to change the interruption level prior to delivery by using a Notification Service Extension.

Apple will provide you with an entitlement file for critical push notifications once it is approved. Link to the form: https://developer.apple.com/contact/request/notifications-critical-alerts-entitlement/

Build changes

Following capability needs to be added to your Xcode project during the build to enable the time-sensitive notifications.

Payload Change

The string values “passive”, “active”, “time-sensitive”, or “critical” correspond to the UNNotificationInterruptionLevel enumeration cases.

Generating the CSR and p12

1. Open Keychain Access on your Mac (it is in Applications/Utilities) and choose the menu option Request a Certificate from a Certificate Authority.

   

2. In the Certificate Assistant window, update the following:

   

   1. Enter your email address.
   2. Enter your application name here, for example, I have entered "Demo". You can type anything you want here, but choose something descriptive. This allows us to easily find the private key later.
   3. Check Saved to disk and click Continue.
3. If you go to the Keys section of Keychain Access, you will see that a new private key has appeared in your keychain.
4. Right-click the new private key and choose Export.
5. Save the private key as DemoKey.p12 and enter a passphrase. (Do choose a passphrase that you can recall! Or you won’t be able to use the private key later.)

Generating the aps cert

1. Assuming you have already created the Identifier for your app bundle id, now navigate to the Certificates section in the developer console. Click the + next to Certificates.

   

2. Choose the Apple Push Notification service SSL (Sandbox & Production) option and click Continue.

   

3. Now select the App Id from the already registered (of your app) list in the Identifier section and then click Continue.

   

4. Now click on Choose File and select the CSR file that we have generated above and click on Continue.

   

5. Now we have successfully generated the aps.cer file, click the Download button to download the cer file. Let’s say the downloaded file name is aps.cer.

   

Generating the PEM file

Now, we have three files:

1. The CSR
2. The private key as a p12 file (HclcdpDemoKey.p12)
3. The SSL certificate (aps.cer)

You have to convert the certificate and private key into a format that is more usable. Because our server will need the cert.pem and key.pem file to deliver the push notification, now we will generate them by using the following procedure.

We are going to use the command-line OpenSSL tools for this. Open a Terminal and execute the following steps.

1. Convert the .cer file into a .pem file:

   $ openssl x509 -in aps.cer -inform der -out HclcdpDemoCert.pem

2. Convert the private key’s .p12 file into a .pem file:

   $ openssl pkcs12 -nocerts -out HclcdpDemoKey.pem -in HclcdpDemoKey.p12

    Enter Import Password: 
    MAC verified OK
    Enter PEM pass phrase: 
    Verifying - Enter PEM pass phrase: 

3. You first need to enter the passphrase for the .p12 file so that openssl can read it. Then you need to enter a new passphrase that will be used to encrypt the PEM file.
   Note: If you don't enter a PEM passphrase, openssl will not give an error message but the generated .pem file will not have the private key in it.
4. Now let’s try to test whether the certificate works, by using our SSL certificate and private key:

   $ openssl s_client -connect gateway.push.apple.com:2196 -cert HclcdpDemoCert.pem -key
            HclcdpDemoKey.pem

   Enter pass phrase for HclcdpDemoCert.pem:

Now please share the following with your account manager for us to be able to send push notifications

1. cert.pem and key.pem (Generated above)
2. passphrase (if any given in the above steps)
3. bundle identifier of the app