COREASP iOS SDK

概要

COREASP iOS SDK は、プッシュ通知ASPサービス「CORE ASP」の iOS用のSDKになります。 ドキュメントは CORE ASP Developer Supportサイトに掲載しております。

■公式サイト

CORE ASP：http://core-asp.com

CORE ASP Developer Support（開発者向け）：http://developer.core-asp.com

前提

• iOSバージョンは8.0以上が動作対象になります。
• Xcodeバージョンは8.0以上が動作対象になります。
• Xcodeのプロジェクトのターゲットを選択し、[Build Phases]の[Link Binary With Libraries]から SDK/COREASP.framework を追加してください。

アプリの通知設定

CORE PUSHの設定キーの指定

CORE ASP管理画面 にログインし、ホーム画面からiOSアプリの設定キーを確認してください。 この設定キーをCorePushManager#setConfigKey で指定します。

CorePushManager.shared.configKey = "＜設定キーの値＞"

CorePushManagerクラスのデリゲートクラスの指定

アプリケーションの動作状態に応じて通知をハンドリングするために、CorePushManagerDelegateプロトコルを実装した クラスを CorePushManager#setDelegate で指定します。

CorePushManager.shared.delegate = self

UNUserNotificationCenterDelegateのデリゲートクラスの指定

iOS10以上の場合は、UNUserNotificationCenterDelegateのデリゲートクラスを別途指定します。

// iOS10以上の場合の通知のデリゲート設定
if #available(iOS 10.0, *) {
    UNUserNotificationCenter.current().delegate = self
}

XcodeのCapabilitiesの設定

Xcodeの[Capabilities]の設定において、[Push Notifications]と[Background Modes]をONに指定してください。また、[Background Modes]の[Modes]において、[Remote notifications]にチェックを入れてください。

デバイスの通知登録解除

デバイスが通知を受信できるようにするには、CORE ASPサーバにデバイストークンを送信します。またデバイスが通知を受信できないようにするには、CORE ASPサーバからデバイストークンを削除します。

通知登録

CorePushManager#registerForRemoteNotifications を呼び出すことで APNSサーバからデバイストークンを取得し、デバイストークンをCORE ASPサーバに送信します。また、デバイストークンの送信時に 端末名、OSバージョン、最終利用時間を自動送信します。

CorePushManager.shared.registerForRemoteNotifications()

本メソッドはアプリの初回起動時かON/OFFスイッチなどで通知をONにする場合に使用してください。

通知解除

CorePushManager#unregisterDeviceToken を呼び出すことで CORE ASPサーバからデバイストークンを削除します。

CorePushManager.shared.unregisterDeviceToken()

本メソッドはON/OFFスイッチなどで通知をOFFにする場合に使用してください。

通知受信後の動作設定

アプリケーションの動作状態に応じて通知をハンドリングすることができます。

バックグランド状態で動作中に通知から起動した場合

バックラウンド状態からの通知起動をハンドリングするために、以下のメソッドを呼び出します。

CorePushManager.shared.handleRemoteNotification(userInfo)

iOS10未満ではUIApplication#application:didReceiveRemoteNotification:fetchCompletionHandler: にて、メソッドを呼び出してください。

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    NSLog("---- application:didReceiveRemoteNotification:fetchCompletionHandler: ----")

    CorePushManager.shared.handleRemoteNotification(userInfo)
    CorePushManager.resetApplicationIconBadgeNumber()

    completionHandler(.noData)
}

iOS10以上ではUNUserNotificationCenterDelegate#userNotificationCenter(_:didReceive:withCompletionHandler:) にて、メソッドを呼び出してください。

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {

    if response.notification.request.trigger is UNPushNotificationTrigger {
        let userInfo = response.notification.request.content.userInfo
        CorePushManager.shared.handleRemoteNotification(userInfo)
    }

    completionHandler()
}

アプリケーションがバックグランド状態で動作中の場合は、CorePushManagerDelegate#handleBackgroundNotification が呼び出されます。

フォアグラウンド状態で動作中に通知を受信した場合

フォアグランド状態からの通知起動をハンドリングするために、以下のメソッドを呼び出します。

CorePushManager.shared.handleRemoteNotification(userInfo)

iOS10未満ではUIApplication#application:didReceiveRemoteNotification:fetchCompletionHandler: にて、メソッドを呼び出してください。

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {        
    CorePushManager.shared.handleRemoteNotification(userInfo)
    CorePushManager.resetApplicationIconBadgeNumber()

    completionHandler(.noData)
}

iOS10以上では userNotificationCenter(_:willPresent:withCompletionHandler:) にて、メソッドを呼び出してください。

@available(iOS 10.0, *)
func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    let userInfo = notification.request.content.userInfo

    if notification.request.trigger is UNPushNotificationTrigger {
        CorePushManager.shared.handleRemoteNotification(userInfo)
        completionHandler([])

//*********************************************************************************************
//    // フォアグランド時に通知センターに通知を表示する場合の設定 (こちらの設定を使用する場合は、上記の２行のコードを削除する)
//    completionHandler([.badge, .sound, .alert])
//*********************************************************************************************
    }
}

アプリケーションがフォアグラウンド状態で動作中の場合は、CorePushManagerDelegate#handleForegroundNotification が呼び出されます。

アプリケーションが動作していない状態で通知から起動した場合

UIApplication#application:didFinishLaunchingWithOptions にて、以下のメソッドを呼び出します。

CorePushManager.shared.handleLaunchingNotification(withOption: launchOptions)

アプリケーションが動作していない状態で通知から起動した場合はCorePushManagerDelegate#handleLaunchingNotification が呼び出されます。

通知履歴の表示

通知履歴の取得

CorePushNotificationHistoryManager#requestNotificationHistory を呼び出すことで通知履歴を最大100件取得できます。

CorePushNotificationHistoryManager.shared.requestNotificationHistory()

取得した通知履歴のオブジェクトの配列は、CorePushNotificationHistoryManager#notificationHistoryModelArray に格納されます。

CorePushNotificationHistoryManager.shared.notificationHistoryModelArray

上記の配列により、個々の通知履歴の CorePushNotificationHistoryModel オブジェクトを取得できます。CorePushNotificationHistoryModelオブジェクトには、履歴ID、通知メッセージ、通知日時、リッチ通知URLが格納されます。

// 例) 451
let historyId = notificationHistoryModel.historyId

// 例) CORE PUSH からのお知らせ!
let message = notificationHistoryModel.message

// 例) http://core-asp.com
let url = notificationHistoryModel.url

// 例) 2012-08-18 17:48:30
let regDate = notificationHistoryModel.regDate

通知履歴の未読管理

CorePushNotificationHistoryManager#setRead を呼び出すことで通知履歴の履歴ID毎に未読を管理することができます。以下は、ある履歴IDの 通知メッセージを既読に設定する例になります。

//タップされた場合、該当する通知メッセージを既読に設定する。
CorePushNotificationHistoryManager.shared.setRead(historyId)

また、CorePushNotificationHistoryManager#getUnreadNumber を呼び出すことで 通知履歴の配列全体の未読数を取得することができます。

CorePushNotificationHistoryManager.shared.getUnreadNumber()

取得した未読数は、タブのバッジ数やアイコンのバッジ数などに用いることができます。

//タブのバッジ数に未読数を設定する場合
self.tabBarItem.badgeValue = "\(unreadNumber)"

//アイコンのバッジ数に未読数を設定する場合
CorePushManager.setApplicationIconBadgeNumber(unreadNumber)

リッチ通知

リッチ通知用のURLパラメータの取得

リッチ通知を受信した場合は、通知オブジェクト内にリッチ通知用のURLが含まれます。 リッチ通知用のURLは、以下の方法で取得できます。

let url = userInfo["url"]

リッチ通知用のURLパラメータの活用(特定の画面への遷移)

// 1:北海道、2:東北 3:関東、4:近畿
let categoryIds = ["1", "2", "3", "4"]
CorePushManager.shared.categoryIds = categoryIds

// 1:地域、2:性別 3:年代 4:好きなジャンル(複数選択可の場合)
let multiCategoryIds = [
    "1": ["神奈川"],　    // 地域が「神奈川」の場合
    "2": ["男性"],       // 性別が「男性」の場合
    "3": ["20代"],       // 年代が「20代」の場合
    "4": ["音楽", "読書"] // 好きなジャンルが「音楽」と「読書」の場合
]
CorePushManager.shared.multiCategoryIds = multiCategoryIds 

//アプリのユーザーIDを登録
CorePushManager.shared.appUserId = "UserId"

//デバイストークンの登録
CorePushManager.shared.registerForRemoteNotifications()

// アプリ内でのユーザーの識別IDを登録
CorePushManager.shared.appUserId = "UserId"

// ユーザー属性の配列を作成。例) 1:いいね時の通知許可、3:コメント時の通知許可、7:フォロー時の通知許可
let attributes = ["1", "3", "7"]

//ユーザー属性を送信する御社の任意のURLを指定
let userAttributeApi = "ユーザ属性を送信する御社の任意のURL"

//アプリ内でのユーザーの識別IDとユーザー属性の送信
 CorePushManager.shared.registerUserAttributes(attributes, api: userAttributeApi)

//通知IDの取得
if let pushId = userInfo["push_id"] as? String {
    // 通知IDを送信します。通知IDは userInfoオブジェクトから push_id キーで
    // 取得できます。また、通知から起動した地点の緯度・経度を指定することができます。緯度・経度を
    // 送信しない場合は latitude、longitudeパラメータに 0 を指定します。
    CorePushAnalyticsManager.shared.requestAppLaunchAnalytics(pushId, latitude: "0", longitude: "0")
}