ios -- 極光推送《3》 pod 方法

時間 2019-11-11

標籤 ios 極光推送 pod 方法欄目 iOS 简体版

原文原文鏈接

iOS SDK 集成指南

SDK說明

適用版本

本文匹配的 SDK版本：r2.1.5 之後。
查看最近更新瞭解最新的SDK更新狀況。
使用Xcode 6及以上版本可使用新版Push SDK，Xcode 5環境下須要運行舊版本SDK(1.7.4)ios

資源文件

包名爲JPush-iOS-SDK-{版本號}api

lib文件夾：包含頭文件 JPUSHService.h，靜態庫文件jpush-ios-x.x.x.a，jcore-ios-x.x.x.a，支持的iOS版本爲 6.0 及以上版本。（請注意：模擬器不支持APNs）
pdf文件：集成指南
demo文件夾：示例

建立應用

在 JPush的管理Portal 上建立應用並上傳APNs證書。若是對APNs證書不太瞭解請參考： iOS 證書設置指南

建立成功後自動生成 AppKey 用以標識該應用。

配置工程

導入SDK

選擇1：Cocoapods導入xcode

經過Cocoapods下載地址：

pod 'JPush'

若是須要安裝指定版本則使用如下方式（以3.0.2版本爲例）：

pod 'JPush', '3.0.2'

選擇2：手動導入app

在極光官網下載最新SDK
將SDK包解壓，在Xcode中選擇「Add files to 'Your project name'...」，將解壓後的lib子文件夾（包含JPUSHService.h、jpush-ios-x.x.x.a、jcore-ios-x.x.x.a）添加到你的工程目錄中。
添加Framework
- CFNetwork.framework
- CoreFoundation.framework
- CoreTelephony.framework
- SystemConfiguration.framework
- CoreGraphics.framework
- Foundation.framework
- UIKit.framework
- Security.framework
- libz.tbd (Xcode7如下版本是libz.dylib)
- AdSupport.framework (獲取IDFA須要；若是不使用IDFA，請不要添加)
- UserNotifications.framework (Xcode8及以上)
- libresolv.tbd (JPush 2.2.0及以上版本須要, Xcode7如下版本是libresolv.dylib)

注意：若是集成JPush 3.0.1及以上版本，且同時集成極光其餘SDK（如：JMessage 3.0.0及以上版本）
1. Cocoapods導入，建議都更新爲線上最新版本，來避免Jcore版本不一致致使的衝突。
2. 手動導入，在工程中只需保留一個最新版本的jcore-ios-x.x.x.a靜態庫文件。less

Build Settings

若是你的工程須要支持小於7.0的iOS系統，請到Build Settings 關閉 bitCode 選項，不然將沒法正常編譯經過。dom

設置 Search Paths 下的 User Header Search Paths 和 Library Search Paths，好比SDK文件夾（默認爲lib）與工程文件在同一級目錄下，則都設置爲"$(SRCROOT)/{靜態庫所在文件夾名稱}"便可。

Capabilities

如使用Xcode8及以上環境開發，請開啓Application Target的Capabilities->Push Notifications選項，如圖：
ide

容許Xcode7支持Http傳輸方法

若是您使用的是2.1.9及以上的版本則不須要配置此步驟
若是用的是Xcode7或更新版本，須要在App項目的plist手動配置下key和值以支持http傳輸:fetch

選擇1：根據域名配置ui

在項目的info.plist中添加一個Key：NSAppTransportSecurity，類型爲字典類型。
而後給它添加一個NSExceptionDomains，類型爲字典類型；
把須要的支持的域添加給NSExceptionDomains。其中jpush.cn做爲Key，類型爲字典類型。
每一個域下面須要設置2個屬性：NSIncludesSubdomains、NSExceptionAllowsInsecureHTTPLoads。兩個屬性均爲Boolean類型，值分別爲YES、YES。

如圖：debug

選擇2：全局配置

<key>NSAppTransportSecurity</key> 
  <dict> 
    <key>NSAllowsArbitraryLoads</key> 
    <true/> 
  </dict>

添加頭文件

請將如下代碼添加到 AppDelegate.m 引用頭文件的位置。

// 引入JPush功能所需頭文件
#import "JPUSHService.h"
// iOS10註冊APNs所需頭文件
#ifdef NSFoundationVersionNumber_iOS_9_x_Max
#import <UserNotifications/UserNotifications.h>
#endif
// 若是須要使用idfa功能所須要引入的頭文件（可選）
#import <AdSupport/AdSupport.h>

添加Delegate

爲AppDelegate添加Delegate。

參考代碼：

@interface AppDelegate ()<JPUSHRegisterDelegate>

@end

添加初始化代碼

2.1.0版本開始,API類名爲JPUSHService，再也不使用原先的APService。

添加初始化APNs代碼

請將如下代碼添加到
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

//Required
  //notice: 3.0.0及之後版本註冊能夠這樣寫，也能夠繼續用以前的註冊方式
  JPUSHRegisterEntity * entity = [[JPUSHRegisterEntity alloc] init];
  entity.types = JPAuthorizationOptionAlert|JPAuthorizationOptionBadge|JPAuthorizationOptionSound;
  if ([[UIDevice currentDevice].systemVersion floatValue] >= 8.0) {
    // 能夠添加自定義categories
    // NSSet<UNNotificationCategory *> *categories for iOS10 or later
    // NSSet<UIUserNotificationCategory *> *categories for iOS8 and iOS9
  }
  [JPUSHService registerForRemoteNotificationConfig:entity delegate:self];

添加初始化JPush代碼

請將如下代碼添加到
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

// Optional
  // 獲取IDFA
  // 如需使用IDFA功能請添加此代碼並在初始化方法的advertisingIdentifier參數中填寫對應值
  NSString *advertisingId = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];

  // Required
  // init Push
  // notice: 2.1.5版本的SDK新增的註冊方法，改爲可上報IDFA，若是沒有使用IDFA直接傳nil
  // 如需繼續使用pushConfig.plist文件聲明appKey等配置內容，請依舊使用[JPUSHService setupWithOption:launchOptions]方式初始化。
  [JPUSHService setupWithOption:launchOptions appKey:appKey
                        channel:channel
               apsForProduction:isProduction
          advertisingIdentifier:advertisingId];

部分參數說明：

appKey
- 填寫管理Portal上建立應用後自動生成的AppKey值。請確保應用內配置的 AppKey 與 Portal 上建立應用後生成的 AppKey 一致。
channel
- 指明應用程序包的下載渠道，爲方便分渠道統計，具體值由你自行定義，如：App Store。
apsForProduction
- 1.3.1版本新增，用於標識當前應用所使用的APNs證書環境。
- 0 (默認值)表示採用的是開發證書，1 表示採用生產證書發佈應用。
- 注：此字段的值要與Build Settings的Code Signing配置的證書環境一致。
advertisingIdentifier
- 詳見關於IDFA。

註冊APNs成功並上報DeviceToken

請在AppDelegate.m實現該回調方法並添加回調方法中的代碼

- (void)application:(UIApplication *)application 
didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {

  /// Required - 註冊 DeviceToken
  [JPUSHService registerDeviceToken:deviceToken];
}

實現註冊APNs失敗接口（可選）

- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {
  //Optional
  NSLog(@"did Fail To Register For Remote Notifications With Error: %@", error);
}

添加處理APNs通知回調方法

請在AppDelegate.m實現該回調方法並添加回調方法中的代碼

#pragma mark- JPUSHRegisterDelegate

// iOS 10 Support
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(NSInteger))completionHandler {
  // Required
  NSDictionary * userInfo = notification.request.content.userInfo;
  if([notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
    [JPUSHService handleRemoteNotification:userInfo];
  }
  completionHandler(UNNotificationPresentationOptionAlert); // 須要執行這個方法，選擇是否提醒用戶，有Badge、Sound、Alert三種類型能夠選擇設置
}

// iOS 10 Support
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler {
  // Required
  NSDictionary * userInfo = response.notification.request.content.userInfo;
  if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
    [JPUSHService handleRemoteNotification:userInfo];
  }
  completionHandler();  // 系統要求執行這個方法
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {

  // Required, iOS 7 Support
  [JPUSHService handleRemoteNotification:userInfo];
  completionHandler(UIBackgroundFetchResultNewData);
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {

  // Required,For systems with less than or equal to iOS6
  [JPUSHService handleRemoteNotification:userInfo];
}

添加處理JPush自定義消息回調方法

如需使用JPush的自定義消息功能，請參考文檔來實現自定義消息的處理回調方法。

成功運行

真機調試該項目，若是控制檯輸出如下日誌則表明您已經集成成功。

2016-08-19 17:12:12.745823 219b28[1443:286814]  | JPUSH | I - [JPUSHLogin] 
----- login result -----  
uid:5460310207   
registrationID:171976fa8a8620a14a4

若是調試運行中遇到問題請參考：iOS SDK 調試指南

高級功能

關於IDFA

r2.1.5版本增長一個上傳IDFA字符串的接口

+ (void)setupWithOption:(NSDictionary *)launchingOption
                  appKey:(NSString *)appKey
                 channel:(NSString *)channel
        apsForProduction:(BOOL)isProduction
   advertisingIdentifier:(NSString *)advertisingId;

若是不使用IDFA，仍可以使用接口

+ (void)setupWithOption:(NSDictionary *)launchingOption
                  appKey:(NSString *)appKey
                 channel:(NSString *)channel
        apsForProduction:(BOOL)isProduction;