Кастомизация iOS SDK

• Deep linking
• Отслеживание встроенных покупок
• Push-уведомления на основе геозон
• Создание очереди Rich Media
• Автоматическое воспроизведение видео из Rich Notification по Force Touch
• Пользовательский звук push-уведомления
• Предварительные push-уведомления iOS (Provisional Push)

В вашем файле Info.plist добавьте массив URL types с URL Identifier и URL Scheme.
В примере ниже URL Scheme — com.pushwoosh, а URL Identifier — promotion.

В файле делегата вашего приложения (обычно AppDelegate.m для iOS 12 и ниже, или SceneDelegate.m для iOS 13 и выше) добавьте соответствующую делегатную функцию openURL, как показано в примере ниже. Пример проверяет правильность страницы, извлекает значение «id» из URL и в ответ открывает PromoPageViewController.

AppDelegate.swift

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    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
}

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
    NSURLComponents *components = [NSURLComponents componentsWithURL:url resolvingAgainstBaseURL:NO];
    NSString *page = components.host;
    NSString *promotionId = nil;

    //return if this is not a promotion deep link
    if(
![page isEqualToString:@"promotion"])

        return NO;

    for(NSURLQueryItem *item in components.queryItems)
    {
        if([item.name isEqualToString:@"id"])
            promotionId = item.value;
    }

    PromoPageViewController *vc = [[PromoPageViewController alloc] init];
    vc.promotionId = promotionId
    [self presentViewController:vc animated:YES completion:nil];
}

SceneDelegate.swift

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let urlContext = URLContexts.first else { return }

    let components = URLComponents(url: urlContext.url, resolvingAgainstBaseURL: false)
    let page = components?.host
    var promotionId: String?

    guard page == "promotion" else {
        return
    }

    let items = components?.queryItems ?? []

    for item in items {
        if item.name == "id" {
            promotionId = item.value
        }
    }

    //show PromoPageViewController
}

- (void)scene:(UIWindowScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    UIOpenURLContext *urlContext = URLContexts.anyObject;
    if (!urlContext) {
        return;
    }

    NSURLComponents *components = [NSURLComponents componentsWithURL:urlContext.URL resolvingAgainstBaseURL:NO];
    NSString *page = components.host;
    NSString *promotionId = nil;

    if (
![page isEqualToString:@"promotion"])
 {
        return;
    }

    for (NSURLQueryItem *item in components.queryItems) {
        if ([item.name isEqualToString:@"id"]) {
            promotionId = item.value;
        }
    }

    //show PromoPageViewController
}

По умолчанию отслеживание встроенных покупок отключено. Если вы хотите отслеживать встроенные покупки при настройке Customer Journeys, установите флаг Pushwoosh_PURCHASE_TRACKING_ENABLED в значение true в файле info.plist. Список доступных флагов вы можете найти в таблице.

Если вы хотите отслеживать встроенные покупки вручную, вы можете использовать код ниже.

В делегатном методе paymentQueue:updatedTransactions: вызовите метод sendSKPaymentTransactions из 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
 }

- (void)paymentQueue:(SKPaymentQueue *)queue updatedTransactions:(NSArray *)transactions {

  [[PushNotificationManager pushManager] sendSKPaymentTransactions:transactions];

  //the rest of the code, consume transactions, etc
}

Push-уведомления на основе геозон вынесены в отдельный фреймворк PushwooshGeozones.

1. Добавьте PushwooshGeozones.framework в ваш проект

Чтобы добавить PushwooshGeozones.framework в ваш проект с помощью менеджера зависимостей, добавьте следующие строки в ваш podfile или cartfile:

pod 'PushwooshXCFramework/Geozones'

github "Pushwoosh/pushwoosh-ios-sdk"

Как вариант, вы можете просто перетащить фреймворк в Link Binaries With Libraries в разделе Build Phases вашего проекта.

2. Добавьте следующие ключи в ваш Info.plist:

• NSLocationWhenInUseUsageDescription – (обязательно), чтобы приложение отслеживало геозоны только в активном режиме.
• NSLocationAlwaysAndWhenInUseUsageDescription – (обязательно), чтобы приложение отслеживало геозоны как в активном, так и в фоновом режиме и для отображения всплывающего окна с запросом на разрешение.
• NSLocationAlwaysUsageDescription – (опционально), чтобы приложение отслеживало геозоны в любое время; следует использовать, если ваше приложение ориентировано на iOS 10 и более ранние версии.

<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>for app to track Geozones in both conditions and to show a permission request dialog</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>for app to track Geozones only while running in the foreground</string>

3. Импортируйте фреймворк

import PushwooshGeozones

#import <PushwooshGeozones/PWGeozonesManager.h>

4. Запустите отслеживание геозон

PWGeozonesManager.shared()?.startLocationTracking()

[[PWGeozonesManager sharedManager] startLocationTracking];

override func viewDidLoad() {
    super.viewDidLoad()

    // Start Geozones tracking when needed
    PWGeozonesManager.shared().startLocationTracking()
}

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.

    // Start Geozones tracking when needed
    [[PWGeozonesManager sharedManager] startLocationTracking];
}

В случае, когда необходимо одновременно отобразить несколько Rich Media страниц (например, триггерные события для двух или более In-App сообщений происходят в один момент, или Rich Media страница уже отображается в момент возникновения другого триггерного события), вы можете настроить очередь для отображения Rich Media страниц. Чтобы создать очередь, выполните следующие шаги.

1. Создайте класс, реализующий 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. Установите делегата:

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

Чтобы видео, отправленное как вложение Rich Notification, автоматически воспроизводилось при раскрытии уведомления без какого-либо взаимодействия с пользователем, выполните следующие шаги:

1. Добавьте в свой проект расширение контента уведомлений (Notification Content Extension):

• В Xcode выберите File > New > Target.
• Выберите Notification Content Extension.
• Присвойте ему имя и завершите настройку.

Если появится сообщение «Activate scheme», выберите Cancel.

2. Настройте свойства и методы в расширении контента следующим образом:

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()
    }

3. Добавьте UIView в MainInterface.storyboard:

4. Свяжите IBOutlet playerBackgroundView с только что добавленным UIView:

5. Обновите файл info.plist, добавив следующую запись:

UNNotificationExtensionUserInteractionEnabled = true

Чтобы прикрепить видео к вашему уведомлению, введите URL видео в поле Media Attachment в Control Panel:

При отправке уведомления через API-запрос /createMessage укажите URL в параметре ios_attachment и убедитесь, что флаг mutable-content установлен в 1.

Чтобы воспроизвести пользовательский звук при получении push-уведомления, сначала поместите аудиофайл в корневую папку вашего проекта.

Затем укажите имя звукового файла в параметрах push-уведомления — заполните поле Sound в настройках для iOS вашего сообщения или укажите имя файла в качестве значения параметра ios_sound в API-запросе createMessage.

Аудиофайл для пользовательского звука iOS должен быть в одном из следующих форматов: .aif, .caf, .wav. Обязательно укажите формат в имени файла; в противном случае Pushwoosh iOS SDK его проигнорирует.

Предварительные push-уведомления появляются в Центре уведомлений пользователя без звука и не отображаются на экране блокировки. Этот тип уведомлений не требует явного разрешения от пользователя: вы можете начать отправлять их, как только пользователь установит и запустит ваше приложение.

Однако у пользователей остается возможность подписаться на ваши заметные push-уведомления: при открытии Provisional Push у них есть два варианта выбора — оставить push-уведомления в Центре уведомлений без оповещений и звуков или разрешить вам отправлять push-уведомления в заметном режиме, чтобы они появлялись на экране блокировки.

Provisional Push созданы для того, чтобы пользователи могли принимать взвешенное решение о том, хотят ли они получать уведомления от вашего приложения. Поскольку нативный запрос на подписку от APN показывается пользователям только один раз, и чтобы подписаться позже, им нужно зайти в системные настройки телефона, некоторые пользователи могут не подписаться, так как не знают, какую пользу принесут им ваши push-уведомления. Provisional Push дают пользователям это понимание: они могут видеть, какой контент вы доставляете в push-уведомлениях, и решать, нужно ли им получать уведомления об этом контенте в заметном режиме.

1. Интегрируйте Pushwoosh iOS SDK, следуя руководству.

2. Добавьте следующую строку в AppDelegate вашего проекта перед вызовом метода registerForPushNotifications():

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

if (@available(iOS 12.0, *)) {
  [Pushwoosh sharedInstance].additionalAuthorizationOptions = UNAuthorizationOptionProvisional;
}

Вот и все! Пользователи приложения будут получать сообщения прямо в свой Центр уведомлений сразу после установки приложения.

Ваши отзывы помогают нам делать наш продукт лучше, поэтому мы будем рады, если вы поделитесь своими впечатлениями о процессе интеграции SDK. Если вы столкнетесь с какими-либо трудностями, пожалуйста, не стесняйтесь поделиться своими мыслями с нами через эту форму.