Customizing iOS SDK

Customize Pushwoosh iOS SDK to meet your goals and preferences

pageSetting up Pushwoosh iOS SDKpageiOS certificate-based configuration

Requirements

  • Create a Pushwoosh account if you do not already have one.

  • A real device with iOS 9 and later. The Xcode simulator doesn't support push notifications so you must test on a real device.

  • A Mac with a new version of Xcode.

  • An iOS Push Certificate. For details, please read the iOS configuration guide.

Integration

Background modes

To ensure that Pushwoosh SDK always receives the push token it is highly recommended to enable the Remote notifications option from the Background modes section of the Capabilities tab in your Xcode project. You can also enable this support by including the UIBackgroundModes key with the remote-notification value in your app’s Info.plist file.

<key>UIBackgroundModes</key>
<array>
    <string>remote-notifications</string>
</array>
Example

Notification alert in foreground

By default, Pushwoosh iOS SDK displays the notification banner when the app is running in the foreground. You can control this behavior by setting the following boolean flag in your code (i.e. in your AppDelegate):

//set false to disable foreground notications, true to enable it
Pushwoosh.sharedInstance().showPushnotificationAlert = true;
Example

Controlling log level

To assist with debugging and integration, SDK will print all requests to the console by default. When you are ready for the production build, set "Pushwoosh_LOG_LEVEL" string key in your Info.plist file to one of the following values, depending on how much you want to see:

NONE - No logs from SDK ERROR - Only display errors in console WARNING - Also display warnings INFO - Add informational messages DEBUG - Add debug information VERBOSE - Everything SDK can print and more

<key>Pushwoosh_LOG_LEVEL</key>
<string>YOUR_LOG_LEVEL</string>

Deep linking

In your Info.plist file add URL types array with URL Identifier and URL Scheme. In the example below the URL Scheme is com.pushwoosh and the URL Identifier is promotion.

In your App Delegate file (usually AppDelegate.m) add openURL delegate function as outlined in the example below. The example checks for the correct page, parses "id" value from the URL and opens PromoPageViewController in response.

func open(_ url: URL, options: [String : Any] = [:], completionHandler completion: ((Bool) -> Swift.Void)? = nil) {
        let components = URLComponents(url: url, resolvingAgainstBaseURL: false)
        let page = components?.host
        var promotionId: String?
        
        if page == "promotion" {
            return
        }
        
        let items = components?.queryItems ?? []
        
        for item in items {
            if item.name == "id" {
                promotionId = item.value
            }
        }
        
        //show PromoPageViewController
    }

In-app purchase tracking

By default, tracking of in-app purchases is disabled. If you want to track in-app purchases when configuring Customer Journeys, set the Pushwoosh_PURCHASE_TRACKING_ENABLED flag to true in the info.plist file. You can find a list of available flags in the table below.

If you want to track in-app purchases manually, you can use the code below.

In paymentQueue:updatedTransactions: delegate method call sendSKPaymentTransactions method of PushManager

 func paymentQueue(_ queue: SKPaymentQueue, updatedTransactions transactions: [SKPaymentTransaction]) {
     // In-Apps Tracking Pushwoosh code here
     Pushwoosh.sharedInstance().sendSKPaymentTransactions(transactions)
     // the rest of the code, consume transactions, etc
 }

Creating a Rich Media queue

In case there are several Rich Media pages to display simultaneously (for example, trigger events for two or more In-Apps take place at one moment, or a Rich Media page is being displayed already at the moment a different trigger event occurs), you can set up a queue for Rich Media pages displaying. To create a queue, follow the steps described below.

  1. Create a class that implements PWRichMediaPresentingDelegate:

@interface ChainedRichMediaPresentingDelegate () <PWRichMediaPresentingDelegate>

@property (nonatomic) NSMutableArray *queue;

@property (nonatomic) BOOL inAppIsPresenting;

@end


@implementation ChainedRichMediaPresentingDelegate

- (instancetype)init {
    self = [super init];
    
    if (self) {
        _queue = [NSMutableArray new];
    }
    
    return self;
}

- (BOOL)richMediaManager:(PWRichMediaManager *)richMediaManager shouldPresentRichMedia:(PWRichMedia *)richMedia {
    [_queue addObject:richMedia];
    return !_inAppIsPresenting;
}

- (void)richMediaManager:(PWRichMediaManager *)richMediaManager didPresentRichMedia:(PWRichMedia *)richMedia {
    _inAppIsPresenting = YES;
}

- (void)richMediaManager:(PWRichMediaManager *)richMediaManager didCloseRichMedia:(PWRichMedia *)richMedia {
    _inAppIsPresenting = NO;
    
    [_queue removeObject:richMedia];
    
    if (_queue.count) {
        [[PWRichMediaManager sharedManager] presentRichMedia:_queue.firstObject];
    }
}

- (void)richMediaManager:(PWRichMediaManager *)richMediaManager presentingDidFailForRichMedia:(PWRichMedia *)richMedia withError:(NSError *)error {
    [self richMediaManager:richMediaManager didCloseRichMedia:richMedia];
}

@end

2. Set the delegate:

 [PWRichMediaManager sharedManager].delegate = [ChainedRichMediaPresentingDelegate new];

Autoplay a video sent in a Rich Notification with force touch

To make a video sent as a Rich Notification attachment autoplay when the notification is expanded without any user interaction, follow the steps below:

  1. Add the Notification Content Extension to your project:

  • In Xcode, select File > New > Target.

  • Choose Notification Content Extension.

  • Assign it a name and complete the setup.

Notification Content Extension - iOS Rich Push Notification

If prompted with the "Activate scheme" message, choose Cancel.

Activate Notification Content Scheme
  1. Adjust the properties and methods in the Content Extension as follows:

import UIKit
import UserNotifications
import UserNotificationsUI
import AVKit


class NotificationViewController: UIViewController, UNNotificationContentExtension {
    var playerController: AVPlayerViewController!
    @IBOutlet weak var playerBackgroundView: UIView!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any required interface initialization here.
    }
    
    func didReceive(_ notification: UNNotification) {
        let attachment = notification.request.content.attachments.first
        
        playerController = AVPlayerViewController()
        // Set height programmatically
        // preferredContentSize.height = 250
        
        if let url = attachment?.url {
            setupVideoPlayer(url: url)
        } else {
            print("No valid URL...")
        }
    }
    
    private func setupVideoPlayer(url: URL) {
        guard let playerController = self.playerController else { return }
        let player = AVPlayer(url: url)
        playerController.player = player
        playerController.view.frame = self.playerBackgroundView.bounds
        playerBackgroundView.addSubview(playerController.view)
        addChild(playerController)
        playerController.didMove(toParent: self)
        player.play()
    }
  1. Incorporate a UIView into MainInterface.storyboard:

UIView in the MainInterface.storyboard
  1. Link the playerBackgroundView IBOutlet with the UIView you just added:

Link the playerBackgroundView IBOutlet with UIView
  1. Update the info.plist file with the following entry:

UNNotificationExtensionUserInteractionEnabled = true
UNNotificationExtensionUserInteractionEnabled = true

In order to attach a video to your notification, input a video’s URL to the Media Attachment field in the Control Panel:

Video’s URL in the Media Attachment field in Pushwoosh Control Panel

When sending a notification via API /createMessage request, include the URL in the "ios_attachment" parameter and ensure the "mutable-content" flag is set to `1`.

To test the autoplay feature, you can use the following sample video: Hello World Sample Video.

Hello World Sample Video

Custom UNNotificationCenterDelegate

If you want to use your own UNNotificationCenterDelegate (for example, for local notifications), you should inform Pushwoosh SDK about it for proper behavior. You can do it with the notificationCenterDelegateProxy property of Pushwoosh instance:

Pushwoosh.sharedInstance()?.notificationCenterDelegateProxy.add(my_delegate)

Then, implement UNNotificationCenterDelegate methods in your delegate:

func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    if (!PWMessage.isPushwooshMessage(notification.request.content.userInfo)) {
        // handle your notification
        completionHandler(UNNotificationPresentationOptions.alert)
    }
}

func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
    if (!PWMessage.isPushwooshMessage(response.notification.request.content.userInfo)) {
        // handle your notification
        completionHandler()
    }
}

Custom push sound

To play a custom sound when on a push notification receiving, first put the audio file into your project's root folder. For example, here's the Pushwoosh sample app with the sound files included: https://github.com/Pushwoosh/pushwoosh-ios-sdk/tree/master/Samples/iPhone

Then, specify the sound file's name in push parameters – fill in the Sound field of the iOS-specific settings of your message or specify the file name as a value for the "ios_sound" param of the createMessage API request.

Audio file for custom iOS sound has to be in one of the following formats: .aif, .caf, .wav. Make sure to specify the format in the file's name; otherwise, it will be ignored by Pushwoosh iOS SDK.

Consider App Store limitations on bundle size when adding the sound file to your bundle.

Complete list of iOS SDK Info.plist properties

PropertyDescriptionPossible values

Pushwoosh_APPID

Sets the Pushwoosh application ID for production build

XXXXX-XXXXX

Type: String

Pushwoosh_APPID_Dev

Sets the Pushwoosh application ID for development build

XXXXX-XXXXX

Type: String

Pushwoosh_SHOW_ALERT

Shows notification foreground alert

YES (default) / NO

Type: Boolean

Pushwoosh_ALERT_TYPE

Sets the notification alert style

BANNER (default) / ALERT / NONE

Type: String

Pushwoosh_BASEURL

Overrides the Pushwoosh server base url

Pushwoosh_AUTO_ACCEPT_DEEP_LINK_FOR_SILENT_PUSH

If YES, Deep Links received in silent pushes will be processed automatically

YES (default) / NO

Type: Boolean

Pushwoosh_ALLOW_SERVER_COMMUNICATION

Allows the SDK to send network requests to Pushwoosh servers

YES (default) / NO

Type: Boolean

Pushwoosh_ALLOW_COLLECTING_DEVICE_DATA

Allows the SDK to collect and to send device data (OS version status, locale and model) to the server

YES (default) / NO

Type: Boolean

Pushwoosh_ALLOW_COLLECTING_DEVICE_OS_VERSION

Allows the SDK to collect and to send device OS version to the server

YES (default) / NO

Type: Boolean

Pushwoosh_ALLOW_COLLECTING_DEVICE_LOCALE

Allows the SDK to collect and to send device locale to the server

YES (default) / NO

Type: Boolean

Pushwoosh_ALLOW_COLLECTING_DEVICE_MODEL

Allows the SDK to collect and to send device model to the server

YES (default) / NO

Type: Boolean

Pushwoosh_LOG_LEVEL

Pushwoosh SDK logging level. For details, refer to Controlling Log Level

NONE / ERROR / WARNING / INFO / DEBUG (default) / VERBOSE

Type: String

Pushwoosh_PURCHASE_TRACKING_ENABLED

Allows the SDK to track in-app purchases. Needed for Customer Journey Builder.

YES / NO (default) Type: Boolean

iOS Provisional Push

Supported on iOS 12 and later.

How it works

Provisional push notifications appear silently in the user’s Notification Center but not on the lock screen. This type of pushes doesn’t need to be allowed by a user explicitly: you can start sending them as soon as a user installs and launches your app.

However, users still can subscribe to your prominent push notifications: when opening the Provisional Push, they have two options to choose their experience – to keep pushes in Notification Center without alerts and sounds or allow you to send pushes prominently so that they appear on the lock screen.

Provisional Pushes are designed to let users make informed decisions about whether they’d like to receive notifications from your app. As the APN native subscription request is shown to users only once and to subscribe later, they should go to their phone’s system settings, and some users might not subscribe since they aren’t aware of what value they get with your pushes. Provisional Pushes give users this understanding: they can see what content you deliver in push notifications and decide whether they need to be notified about this content prominently.

Important!

Please note that Provisional Pushes, when implemented, replace the native APN prompt, which means users cannot subscribe to prominent notifications until they open their Notification Center and choose to receive Provisional Pushes as prominent ones.

How to implement

1. Integrate the Pushwoosh iOS SDK by following the guide.

2. Add the following string to your project's AppDelegate before calling the registerForPushNotifications() method:

if #available(iOS 12.0, *) {
    Pushwoosh.sharedInstance().additionalAuthorizationOptions = UNAuthorizationOptions.provisional
}

That's it! App users will receive messages directly to their Notification Center once they install the app.

Share your feedback with us

Your feedback helps us create a better experience, so we would love to hear from you if you have any issues during the SDK integration process. If you face any difficulties, please do not hesitate to share your thoughts with us via this form.

Last updated