Update a push notification

Note

This feature is only available on iOS devices.

Overview

When sending a new notification, you can also retract the previous push notification. This feature is commonly used to cancel a call invitation, retract a message, and other scenarios.

How it works

ZPNs supports including the "mutable-content":1 field when sending APNs push notifications. This allows your app to intercept the push message, modify its content, and then display it. For more details, please refer to Description of Mutable-content in the Official Documentation of Apple Developer.

Configure resourceID

Contact ZEGO technical support to configure the resourceID that carries "mutable-content":1.

Sender

When sending offline push notifications with ZIMPushConfig, please fill in the above resourceID.

Taking sending a call invitation as an example:

Untitled

var invitees = ['xxxx'];  // List of invitee IDs
var config = { 
    timeout: 60 ,// Invitation timeout in seconds, ranging from 1 to 600   
    pushConfig:{
        title: 'push title',
        content: 'push content',
        payload: '{\"customId\":\"1\"}',// Payload carrying a custom unique identifier
        resourcesID: "resourceID carrying mutable-content"
}}; 
zim.callInvite(invitees, config)
    .then(function({ callID, timeout, errorInvitees }){
        // Operation succeeded
        // The callID here is the ID generated by the SDK to uniquely identify a call invitation after the user initiates a call; this callID will be used when the initiator cancels the call or the invitee accepts/rejects the call
    })
    .catch(function(err){
        // Operation failed
    })

Copied!

Receiver

Configure Capability

Open Xcode, select the target under TARGETS, and go to Signing & Capabilities > Capabilities. Enable Push Notification (for offline push notifications).

Set up Notification Service Extension

Add Notification Service Extension to Targets

Click "File > New > Target..."
In the pop-up window, select "iOS > Notification Service Extension".
Enter the Product Name and other information for the extension.

After creating the extension, a "xxxExtension" folder (xxx is the Product Name entered when adding the extension) will be generated in the project. You will use the NotificationService class file in it.

Configure Capability for the newly added extension

Select the extension target under TARGETS, and then go to "Signing & Capabilities > Capabilities > Push Notification" to enable offline push notifications.

Adjust the minimum supported version of the newly added extension to iOS 11.0 or above

If the iOS version of the used device is lower than the version specified here, the extension will not take effect on that device.

Write the logic to replace the notification

In the NotificationService.m file in the "xxxExtension" folder (xxx is the Product Name entered when adding the extension), write the business logic to update the notification. The example code is as follows:

Untitled

//  NotificationService.m
//  NotificationService

#import "NotificationService.h"
#import <Intents/Intents.h>

@interface NotificationService ()

@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;

@end

@implementation NotificationService


// When push interception is enabled, this method will be triggered when a push notification with "mutable-content":1 is received.
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];
    // Title
    NSString *title = self.bestAttemptContent.title;
    // Subtitle
    NSString *subtitle = self.bestAttemptContent.subtitle;
    // Body
    NSString *body = self.bestAttemptContent.body;

    // Get the payload string carried by the push message
    NSString *payload = [self.bestAttemptContent.userInfo objectForKey:@"payload"];

    if(payload == nil){
        self.contentHandler(self.bestAttemptContent);
        return;
    }
    
    
    // Parse the JSON string and convert it to NSDictionary
    NSData *jsonData = [payload dataUsingEncoding:NSUTF8StringEncoding];
    NSError *error = nil;
    NSDictionary *payload_json_map = [NSJSONSerialization JSONObjectWithData:jsonData options:kNilOptions error:&error];
    if (error) {
        self.contentHandler(self.bestAttemptContent);
        return;
    }
    
    // Extract the unique identifier carried by the payload
    NSString *customId = [payload_json_map objectForKey:@"customId"];

    if(customId != nil){
        [UNUserNotificationCenter.currentNotificationCenter getDeliveredNotificationsWithCompletionHandler:^(NSArray<UNNotification *> * _Nonnull notifications) {
            NSString *target_id = nil;

            // Traverse the existing notifications, find the notification with the same unique identifier, and delete it
            for (int index = 0; index < notifications.count; index ++) {
                if([[notifications[index].request.content.userInfo objectForKey:@"customId"] isEqual: customId]){
                    target_id = notifications[index].request.identifier;
                    break;
                }
            }
            if(target_id != nil){
                [UNUserNotificationCenter.currentNotificationCenter removeDeliveredNotificationsWithIdentifiers:@[target_id]];
            }
            contentHandler(self.bestAttemptContent);
        }];
    }else{
        contentHandler(self.bestAttemptContent);
    }
    
}

@end

Copied!