• Android
• iOS

• Android
• iOS

{
  "useRelease": true,
  "androidVersion": "",
  "android": {
    "baseUrl": "https://mobile-sdk-lib-XX-Y.brilliantcollector.com",
    "appKey": {
      "prod": "INSERT APP KEY HERE"
    }
  }
}

node node_modules/cordova-acoustic-mobile-push/scripts/installPlugins.js

cordova build android

cordova run android

{
  "useRelease": true,
  "iOSVersion": "",
  "iOS": {
    "baseUrl": "https://mobile-sdk-lib-XX-Y.brilliantcollector.com",
    "appKey": {
      "dev": "INSERT YOUR DEV APPKEY HERE",
      "prod": "INSERT YOUR PROD APPKEY HERE"
    }
  }
}

node node_modules/cordova-acoustic-mobile-push/scripts/installPlugins.js

cordova build ios

cordova run ios

🚧

Important

Do not change the app keys after you publish your apps.

Add the iOS Notification Extension

Step A: Add the Notification Service Extension

One of the frameworks installed using the installPlugins.js script is AcousticMobilePushNotification. It lets you enable dynamic action categories and media attachments in iOS notifications. Before a notification from the APNs service is displayed to an end user, the media attachment URL is extracted, and then the media file is downloaded and attached to the notification.

The notification service extension functions as a separate app within your app bundle and requires separate provisioning.

🚧

Important

The notification service target must be compatible with the version of the Campaign library you are using. So if you have a beta version of the library and want to switch to the stable version or visa versa, make sure you unlink the current target first and then add a new one.

1. In your XCode project, click File > New > Target.
2. On the iOS tab, select Notification Service Extension.

3. In the Language list, select Objective-C. Fill out the remaining settings as appropriate.

4. If a confirmation message appears, select Activate.

5. Find a new target and a new directory in your project.

Step B: Configure the Notification Service target

Select the new target and go through the following settings on the General tab.

• Minimum deployments. Make sure the iOS version is the same as in the primary application target.
• Frameworks and Libraries. Add AcousticMobilePushNotification.xcframework and libCordova.a. For AcousticMobilePushNotification.xcframework, the Embed and Sign option must be selected. AcousticMobilePush.xcframework should already be present based on earlier steps in these instructions.

On the Signing & Capabilities tab, add two capabilities: Keychain Sharing and App Groups. Make sure you use the same values as for the primary application target.

On the Build Settings tab, expand the Linking - General section. Make sure Other Linker Flags is set to -ObjC.

Step C: Update related project files

1. In the project navigator, select config.xml. Add the Notification Service target to the file's Target Membership.

2. In the project navigator, open the Plugins directory and select MCEManualConfiguration.m. Add the Notification Service target to the file's Target Membership.

3. In the project navigator, open the Notification Service directory and select NotificationViewController.h. Import the AcousticMobilePushNotification framework.

#import <AcousticMobilePushNotification/AcousticMobilePushNotification.h>

4. In the same file, add an MCE notification service property.

@property MCENotificationService * notificationService;

5. In the same directory, select NotificationViewController.m. Import MCEManualConfiguration.h and AcousticMobilePush.h.

#import "MCEManualConfiguration.h"
#import "AcousticMobilePush/AcousticMobilePush.h"

6. Create an initializer method to initialize the MCENotificationService property:

- (instancetype)init {
  if (self = [super init]) {
    [MCEConfig sharedInstanceWithDictionary:MCEManualConfiguration.xmlSettings];
    self.notificationService = [[MCENotificationService alloc] init];
  }
  return self;
}

7. Update the didReceiveNotificationRequest method to use the notification-action.

if (request.content.userInfo[@"notification-action"]) {
  [self.notificationService didReceiveNotificationRequest:request
                                       withContentHandler:contentHandler];
  return;
}

8. In the serviceExtensionTimeWillExpire method, call the mce mobile push method of the same name.

[self.notificationService serviceExtensionTimeWillExpire];

9. In order to support the latest iOS version, make sure that config.xml in the root directory has the following entry.

<platform name="ios">
	<preference name="deployment-target" value="13.0"" />
</platform>

10. Run the following Node.js command from the main project directory.

node node_modules/cordova-acoustic-mobile-push/scripts/installPlugins.js

Here are sample NotificationViewController files for your reference.

#import <UserNotifications/UserNotifications.h>
#import <AcousticMobilePushNotification/AcousticMobilePushNotification.h>
@interface NotificationService : UNNotificationServiceExtension
@property MCENotificationService * notificationService;
@end

#import "NotificationService.h"
#import "MCEManualConfiguration.h"
  
@interface NotificationService ()
  
@property (nonatomic, strong) void (^contentHandler)
(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNMutableNotificationContent
*bestAttemptContent;

@end
  
@implementation NotificationService
-(instancetype)init {
    if(self = [super init]) {
        [MCEConfig sharedInstanceWithDictionary: MCEManualConfiguration.
xmlSettings];
        self.notificationService = [[MCENotificationService alloc]
init];
    }
   return self;
}

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request
withContentHandler:(void (^)(UNNotificationContent * _Nonnull))
contentHandler {
    if(request.content.userInfo[@"notification-action"]) {
        [self.notificationService didReceiveNotificationRequest:
request withContentHandler: contentHandler];
        return;
    }
}

- (void)serviceExtensionTimeWillExpire {
    [self.notificationService serviceExtensionTimeWillExpire];
}

@end

Further steps

When you finish testing and are ready to try more features, consider enabling notification action plugins. Here is a full list with instructions for Cordova.