objc,swift

プッシュ通知（iOS）¶

プッシュ通知の設定 (iOS)¶

Reproからプッシュ通知を送信するには.p12形式の証明書が必要です。そのために以下の手順でp12形式の証明書を作成します。

APP IDの作成¶

証明書を作成するために必要な「APP ID」を作成します。

iOS Developer Center のメンバーセンターにログインし、 Certificates, Identifiers & Profiles をクリックします。

Identifiers をクリックします。

APP IDsを開き、APP IDを追加するために＋ボタンをクリックします。すでにAPP IDを作成済みの場合は CSRの作成 へおすすみください。

下記の項目を入力して Continue をクリックします。

APP ID Description:
- APP IDの名前を入力します。管理者が判別しやすい任意の名前を入力してください。
APP ID Suffix:
- APP IDの種類を決めます。Explicit APP IDを選択し、Bundle IDを入力します。Bundle IDはプッシュ通知を送信したいアプリのBundle IDと同一のもの設定してください。
APP Services:
- アプリで使用するサービスを設定します。Push Notificationsにチェックします。

入力内容を確認し、 Submit するとAPP IDが作成されます。現段階ではPush Notificationsが黄色のConfigurableになっていますが、証明書を作成すると緑色のEnabledになります。

CSRの作成¶

証明書を作成するために必要な「CSR（証明書署名要求）」を作成します。CSRはお使いのMacのキーチェーンアクセスで作成することができます。

キーチェーンアクセス -> 証明書アシスタント -> 認証局に証明書を要求...を選択します。

メールアドレス と通称を入力し、 ディスクに保存 にチェックして 続ける をクリックします。

CSRファイルが作成されますので、任意の場所に保存します。

証明書の作成¶

iOS Developer Centerにて、APP IDsの一覧画面にてAPP IDを選択し、 Edit をクリックします。

Push Notificationsの欄の Create Certificate… をクリックします。 DevelopmentとProductionのそれぞれに異なる証明書が必要です。今回はDevelopmentの証明書を作ります。

注釈

プッシュ通知証明書は、配信対象となるアプリの配布方法(Ad hocまたはIn-House）によって証明書の種類を分けて登録する必要があります。下記の様にそれぞれのアプリ環境にあわせて正しい種類の証明書を選択して下さい。

Development SSL Certificate: IDE(統合開発環境)から直接ビルドしたアプリケーションの場合
Production SSL Certificate: App Storeからダウンロードしたアプリもしくは、TestFlightなどのテストアプリ配布ツール等を利用してAdHoc配布されたアプリの場合

証明書を作成するためにはCSRが必要という旨の説明が表示されます。CSRは先ほど作成したので Continue で進みます。

Upload CSR file にて先ほど作成したCSRファイルを選択し、 Generate をクリックします。

証明書が作成されますので Download をクリックして証明書をダウンロードしてください。

証明書をp12形式に変換する¶

先ほどダウンロードした証明書(.cer形式のファイル)をダブルクリックするとキーチェーンアクセスが起動します。証明書は Apple [Development/Production] iOS Push Services: [Bundle ID] もしくは Apple Push Services: [Bundle ID] のような名前でキーチェーンアクセスに追加されていますので、検索窓にBundle IDの一部を入力すると候補を絞ることができます。

証明書の左の三角マークをクリックし、 証明書 と 秘密鍵 が表示させます。 証明書 のみを選択した状態で control キーを押しながらクリックします。

表示されたポップアップにて [証明書名]を書き出す… を選択します。

表示されたダイアログにてフォーマットが 個人情報交換（.p12） 形式であることを確認し、任意の場所に保存します。

書き出した項目を保護するために使用されるパスワードを入力 というダイアログが表示されます。ここで入力したパスワードを 設定 > プッシュ通知設定 でも入力しますので覚えておいてください。パスワードを設定しなくても問題ありません。

キーチェーンアクセスが証明書を書き出すためにMacのパスワードを入力するとp12形式の証明書が保存されます。

p12形式の証明書をReproにアップロード¶

設定 > プッシュ通知設定 を開きます。「p12ファイル」にて、先ほど作成したp12ファイルを選択します。p12ファイル作成時にパスワードを設定した場合は「証明書のパスワード」欄にパスワードを入力してください。

Provisioning Profileの設定¶

iOS Dev CenterにてProvisioning Profilesを開き、Provisioning Profileを追加するために＋ボタンをクリックします。

Provisioning Profileの種類を「Development」「App Store」「Ad Hoc」のいずれかから選択して Continue をクリックします。

プッシュ通知を送信するAPP IDを選択して Continue をクリックします。

Provisioning Profileに含める証明書を選択して Continue をクリックします。

インストール対象の端末を選択して Continue をクリックします（DevelopmentおよびAd HocのProvisioning Profile作成時のみ）。

Provisioning Profileの名前を入力して Generate をクリックするとProvisioning Profileが作成されます。

「Download」をクリックして作成されたProvisioning Profileをダウンロードします。

ダウンロードしたProvisioning Profileをダブルクリックして、Xcodeに取り込みます。

XcodeのBuild Settingsにて作成したProvisioning Profileを設定します。

バッジを消す処理の実装¶

プッシュ通知作成フォームから「バッジを表示する」をオンにして送信すると、プッシュ通知を受信したアプリのアイコンにバッジが自動で表示されます。

表示されたバッジを消すためには UIApplication クラスの applicationIconBadgeNumber に0をセットする必要があります。アプリの仕様に合わせて任意のタイミングで applicationIconBadgeNumber に0をセットしてください。

例えば、アプリがActiveになったタイミングでバッジを消す場合は UIApplicationDelegate の applicationDidBecomeActive: で applicationIconBadgeNumber に0をセットします。

// AppDelegate.m

@implementation AppDelegate
- (void)applicationDidBecomeActive:(UIApplication *)application
    ...
    application.applicationIconBadgeNumber = 0;
    ...

// AppDelegate.swift

class AppDelegate: UIResponder, UIApplicationDelegate {

    func applicationDidBecomeActive(_ application: UIApplication) {
        ...
        application.applicationIconBadgeNumber = 0
        ...

注釈

「バッジを表示する」をオンにしたプッシュ通知を送信する場合は、必ずバッジクリア処理を実装してください。

デバイストークンをReproに送信¶

プッシュ通知の宛先を指定するためにデバイストークンをReproに送信します。

XcodeのCapabilitiesにてPush NotificationsをONにします。

次に下記のコードを追加してください。

// AppDelegate.m

#import <Repro/Repro.h>
#import <UserNotifications/UserNotifications.h>
    ...
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    ...
    if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_9_x_Max) {
        UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
        [center requestAuthorizationWithOptions:(UNAuthorizationOptionAlert | UNAuthorizationOptionBadge | UNAuthorizationOptionSound) completionHandler:^(BOOL granted, NSError * _Nullable error) {
        }];
        [[UIApplication sharedApplication] registerForRemoteNotifications];
    } else {
        UIUserNotificationType types = UIUserNotificationTypeBadge | UIUserNotificationTypeSound | UIUserNotificationTypeAlert;
        UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:types categories:nil];
        [[UIApplication sharedApplication] registerUserNotificationSettings:settings];
        [[UIApplication sharedApplication] registerForRemoteNotifications];
    }
    return YES;
}

// AppDelegate.swift

import Repro
import UserNotifications
    ...
class AppDelegate: UIResponder, UIApplicationDelegate {
        ...
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        ...
        if #available (iOS 10.0, *) {
            let center = UNUserNotificationCenter.current()
            UNUserNotificationCenter.current().delegate = self
            center.requestAuthorization(options: [.sound, .alert, .badge], completionHandler: { (granted, error) in
            })
            application.registerForRemoteNotifications()
        } else {
            let settings: UIUserNotificationSettings = UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
            UIApplication.shared.registerUserNotificationSettings(settings)
            UIApplication.shared.registerForRemoteNotifications()
        }
        return true
    }

// AppDelegate.m
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
    [Repro setPushDeviceToken:deviceToken];
}

- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
{
    NSLog(@"Remote Notification Error: %@", error);
}

// AppDelegate.swift
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    Repro.setPushDeviceToken(deviceToken)
}

func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
    print("Remote Notification Error: \(error)")
}

デバイストークンの取得に成功した場合は application:didRegisterForRemoteNotificationsWithDeviceToken: メソッドが呼び出されるので、その中でReproにデバイストークンを渡します。

デバイストークンの取得に失敗した場合は application:didFailToRegisterForRemoteNotificationsWithError: メソッドが呼び出されるので、エラーの内容を見て適宜対処します。

以上の実装をした後にアプリを起動すると、下記のようなプッシュ通知の許諾ダイアログが表示されます。

このダイアログにて OK を選択すると application:didRegisterForRemoteNotificationsWithDeviceToken: メソッドが呼び出され、Reproにデバイストークンが設定されます。

以上でプッシュ通知の受信準備は完了です。

リッチ通知の受信準備¶

iOS 10から画像や動画、音声ファイルなどを通知に利用することができるリッチ通知機能が追加されました。リッチ通知を受信するためには下記の手順が必要です。

Notification Service Extensionの作成¶

Xcodeのメニューの File -> New -> Target... をクリックします。

../../../_images/7-1-AddNotificationServiceExtention.png

iOS -> Notification Service Extension -> Next をクリックします。

../../../_images/7-2-AddNotificationServiceExtention.png

任意のProduct Nameを入力してFinishをクリックします。

../../../_images/7-3-AddNotificationServiceExtention.png

下記のようなダイアログが出てきたら Activate をクリックします。

../../../_images/7-4-AddNotificationServiceExtention.png

Notification Service Extensionの実装¶

Notification Service Extension に下記の記述をします。

#import <UserNotifications/UserNotifications.h>

...

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {

    self.contentHandler = contentHandler;
    self.bestAttemptContent = [request.content mutableCopy];

    NSDictionary *attachment = request.content.userInfo[@"rpr_attachment"];
    if (!attachment) {
        contentHandler(self.bestAttemptContent);
        return;
    }

    NSString *urlStr = attachment[@"url"];
    NSString *type = attachment[@"type"];
    NSURL *url = [NSURL URLWithString:urlStr];

    [[[NSURLSession sharedSession] downloadTaskWithURL:url
                                     completionHandler:^(NSURL * _Nullable location,
                                                         NSURLResponse * _Nullable response,
                                                         NSError * _Nullable error) {

                                         if (error) {
                                             contentHandler(self.bestAttemptContent);
                                             return;
                                         }

                                         NSString *fileName = [NSString stringWithFormat:@"%@.%@", [[NSUUID UUID]UUIDString], type];
                                         NSURL *fileURL = [NSURL fileURLWithPath:[NSTemporaryDirectory() stringByAppendingPathComponent:fileName]];
                                         [[NSFileManager defaultManager] moveItemAtURL:location toURL:fileURL error:nil];

                                         NSError *attachError;
                                         UNNotificationAttachment *attachment = [UNNotificationAttachment attachmentWithIdentifier:@"IDENTIFIER" URL:fileURL options:nil error:&attachError];
                                         if (!attachError) {
                                             self.bestAttemptContent.attachments = @[attachment];
                                         }

                                         contentHandler(self.bestAttemptContent);
                                     }] resume];
}

import UserNotifications
...
class NotificationService: UNNotificationServiceExtension {

    var contentHandler: ((UNNotificationContent) -> Void)?
    var bestAttemptContent: UNMutableNotificationContent?

    override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
        self.contentHandler = contentHandler
        bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)

        if let attachment = request.content.userInfo["rpr_attachment"] as? [String: String] {
            if let urlString = attachment["url"], let fileURL = URL(string: urlString), let type = attachment["type"] {

                URLSession.shared.downloadTask(with: fileURL) { (location, response, error) in
                    if let location = location {
                        let fileName = UUID().uuidString + "." + type
                        let tmpFile = "file://".appending(NSTemporaryDirectory()).appending(fileName)
                        let tmpUrl = URL(string: tmpFile)!
                        try? FileManager.default.moveItem(at: location, to: tmpUrl)

                        if let attachment = try? UNNotificationAttachment(identifier: "IDENTIFIER", url: tmpUrl, options: nil) {
                            self.bestAttemptContent?.attachments = [attachment]
                        }
                    }
                    contentHandler(self.bestAttemptContent!)
                }.resume()
            }
        } else {
            contentHandler(self.bestAttemptContent!)
        }
    }

上記の実装が終わったら、プッシュ通知を作成するをご覧ください。