SDK 集成指南
最近更新:2022-05-12
展开全部

SDK 集成指南

SDK 说明

适用版本

本文匹配的 SDK 版本:r2.1.5 以后。 查看最近更新 了解最新的 SDK 更新情况。 使用 Xcode 6 及以上版本可以使用新版 Push SDK,Xcode 5 环境下需要运行旧版本 SDK(1.7.4)

资源文件

  • Libs 文件夹:包含头文件 JPUSHService.h,静态库文件 jpush-ios-x.x.x.a,jcore-ios-x.x.x.a(请注意:模拟器不支持 APNs)(v4.6.0和v4.6.4版本除了JPUSHService.h,jpush-ios-x.x.x.a,jcore-ios-x.x.x.a,还新增了JAdService.h,JPUSHService+inapp.h,JPUSHService+inapp.m三个文件)
  • Libs-noidfa 文件夹:包含静态库文件 jcore-noidfa-ios-x.x.x.a
  • Libs-NotificationServiceExtension 文件夹:包含 JPushNotificationExtensionService.h 和 jpush-extension-ios-x.x.x.a 文件,该目录为 NotificationServiceExtension SDK,需要使用 APNs 展示统计时集成。
  • JiguangDemo 文件夹:示例

IDFA

从 JPUSH v3.2.2 版本开始,极光提供 idfa 和 noidfa 两个版本,JPUSH v3.2.6 及以上版本由 JCORE 提供 idfa 和 noidfa 两个版本,请注意选择版本集成。 idfa 版本是标准版,默认自动采集 IDFA 数据, noidfa 版本不自动采集。极光建议开发者使 idfa 版本。当然,如果开发者不想使⽤ IDFA 或者担忧采集 IDFA 而未集成任何广告服务遭到 Apple 拒绝,请使用 noidfa 版本。

在iOS14需要去申请用户权限,首先需要在 Info.plist 中配置" NSUserTrackingUsageDescription " 及描述文案,接着使用 AppTrackingTransparency 框架中的 ATTrackingManager 中的 requestTrackingAuthorizationWithCompletionHandler 请求用户权限,在用户授权后再去访问 IDFA 才能够获取到正确信息。
          在iOS14需要去申请用户权限,首先需要在 Info.plist 中配置" NSUserTrackingUsageDescription " 及描述文案,接着使用 AppTrackingTransparency 框架中的 ATTrackingManager 中的 requestTrackingAuthorizationWithCompletionHandler 请求用户权限,在用户授权后再去访问 IDFA 才能够获取到正确信息。

        
此代码块在浮窗中显示

DEMO 使用

进入到 JiguangDemo 目录下,执行 pod instal 命令安装 sdk,打开 JiguangDemo.xcworkspace 运行即可。

JiguangDemo 为多个SDK拼接组装而成的Demo,使用 cocoapods 进行管理,如需手动集成请参考[手动导入]部分。
          JiguangDemo 为多个SDK拼接组装而成的Demo,使用 cocoapods 进行管理,如需手动集成请参考[手动导入]部分。

        
此代码块在浮窗中显示

创建应用

  • 在 JPush 的管理 Portal 上创建应用,创建成功后自动生成 AppKey 用以标识该应用。

  • 在推送设置 iOS 模块上传 APNs 证书或  配置 Token Authentication。如果对 APNs 证书不太了解 请参考: iOS 证书设置指南

  • 详细图示见快速开始 》创建应用

配置工程

导入 SDK

选择 1:Cocoapods 导入

1. 如果使用标准版本(需要特别注意以下“注意事项”)
pod 'JCore' // 可选项,也可由pod 'JPush'自动获取 pod 'JPush' // 必选项 注:如果无法导入最新版本,请执行 pod repo update master 这个命令来升级本机的 pod 库,然后重新 pod 'JPush'
          pod 'JCore'    // 可选项,也可由pod 'JPush'自动获取
pod 'JPush'    // 必选项

注:如果无法导入最新版本,请执行 pod repo update master 这个命令来升级本机的 pod 库,然后重新 pod 'JPush'

        
此代码块在浮窗中显示
  • 如果需要安装指定版本则使用以下方式(以 JPush 4.6.6 版本为例):
pod 'JCore', '3.2.3' // 可选项,也可由pod 'JPush'自动获取 pod 'JPush', '4.6.6' // 必选项
          pod 'JCore', '3.2.3'    //  可选项,也可由pod 'JPush'自动获取
pod 'JPush', '4.6.6'    //  必选项

        
此代码块在浮窗中显示
注意事项

App 在提交苹果审核时,对“此 App 是否使用广告标识符(IDFA)?”,需要选择“是”,并且需要根据 App 使用广告情况,勾选以下选项

  • 在 App 内投放广告 -- 确认是的话需要勾选
  • 标明此 App 安装来自先前投放的特定广告 -- 确认是的话需要勾选
  • 标明此 App 中发生的操作来自先前投放的广告 -- 确认是的话需要勾选
    • 勾选可参考以下示图:
2. 如果使用无 IDFA 版本
  • JPush 3.2.6 及以上版本,如果使用 JCore 2.1.4 及以上版本,使用方式如下(以 JPush 4.6.6 版本、JCore 3.2.3 版本为例):
pod 'JCore', '3.2.3-noidfa' // 必选项 pod 'JPush', '4.6.6' // 必选项
          pod 'JCore', '3.2.3-noidfa'    // 必选项
pod 'JPush', '4.6.6'    // 必选项

        
此代码块在浮窗中显示
  • JPush 3.2.6 及以上版本,如果使用 JCore 2.1.2 及以下版本,使用方式如下(以 JPush 3.2.6 版本为例):
pod 'JCore', '2.1.2' // 必选项 pod 'JPush', '3.2.6' // 必选项
          pod 'JCore', '2.1.2'    // 必选项
pod 'JPush', '3.2.6'    // 必选项

        
此代码块在浮窗中显示
  • JPush 3.2.2、3.2.4 两个版本,如果使用 JCore 2.1.4 及以上版本,使用方式如下(以 JPush 3.2.4 版本为例):
pod 'JCore', '2.1.4-noidfa' // 必选项 pod 'JPush', '3.2.4-noidfa' // 必选项
          pod 'JCore', '2.1.4-noidfa'    // 必选项
pod 'JPush', '3.2.4-noidfa'    // 必选项

        
此代码块在浮窗中显示
  • JPush 3.2.2、3.2.4 两个版本,如果使用 JCore 2.1.2 及以下版本,使用方式如下(以 JPush 3.2.4 版本为例):
pod 'JCore', '2.1.2' // 必选项 pod 'JPush', '3.2.4-noidfa' // 必选项
          pod 'JCore', '2.1.2'    // 必选项
pod 'JPush', '3.2.4-noidfa'    // 必选项

        
此代码块在浮窗中显示

选择 2:手动导入

  • 在极光官网下载 最新 SDK
  • 将 SDK 包解压,在 Xcode 中选择 “Add files to 'Your project name'...”,将解压后的 Libs 子文件夹(包含文件JPUSHService.h、jpush-ios-x.x.x.a、jcore-ios-x.x.x.a)(v4.6.0和v4.6.4版本包含 JPUSHService.h、JAdService.h、JPUSHService+inapp.h、JPUSHService+inapp.m、jpush-ios-x.x.x.a、jcore-ios-x.x.x.a)添加到你的工程目录中。如需使用noidfa版本,则将Libs-noidfa下的jcore-noidfa-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(Xcode 7 以下版本是 libz.dylib)
    • AdSupport.framework(获取 IDFA 需要;如果不使用 IDFA,请不要添加)
    • UserNotifications.framework(Xcode 8 及以上)
    • libresolv.tbd(JPush 2.2.0 及以上版本需要,Xcode 7 以下版本是 libresolv.dylib)
    • WebKit.framework(JPush 3.3.0 及以上版本需要)
    • AppTrackingTransparency.framework(Xcode 12 及以上,获取 IDFA 需要;如果不使用 IDFA,请不要添加)
    • StoreKit.framework(JPush 3.3.6 及以上版本需要)

注意:

如果集成 JPush 3.0.1 及以上版本, 且同时集成极光其他 SDK(如:JMessage 3.0.0 及以上版本)
1. Cocoapods 导入,建议都更新为线上最新版本,来避免 JCore 版本不一致导致的冲突。
2. 手动导入,在工程中只需保留一个最新版本的 jcore-ios-x.x.x.a 静态库文件。

Build Settings

如果你的工程需要支持小于 7.0 的 iOS 系统,请到 Build Settings 关闭 bitCode 选项,否则将无法正常编译通过。

  • 设置 Search Paths 下的 User Header Search Paths 和 Library Search Paths,比如 SDK 文件夹(默认为 lib )与工程文件在同一级目录下,则都设置为 "$(SRCROOT)/{静态库所在文件夹名称}" 即可。

Capabilities

如使用 Xcode 8 及以上环境开发,请开启 Application Target 的 Capabilities->Push Notifications 选项,如图:

如使用 Xcode 10 及以上环境开发,请开启 Application Target 的 Capabilities-> Access WIFI Infomation 选项。 jpush_ios

允许 Xcode 7 支持 Http 传输方法

如果您使用的是 2.1.9 及以上的版本则不需要配置此步骤
如果用的是 Xcode 7 或更新版本,需要在 App 项目的 plist 手动配置下 key 和值以支持 http 传输:

选择 1:根据域名配置

  • 在项目的 info.plist 中添加一个 Key:NSAppTransportSecurity,类型为字典类型。
  • 然后给它添加一个 NSExceptionDomains,类型为字典类型;
  • 把需要的支持的域添加给 NSExceptionDomains。其中 jpush.cn 作为 Key,类型为字典类型。
  • 每个域下面需要设置 2 个属性:NSIncludesSubdomains、NSExceptionAllowsInsecureHTTPLoads。 两个属性均为 Boolean 类型,值分别为 YES、YES。

如图:

jpush_ios

选择 2:全局配置

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

        
此代码块在浮窗中显示

添加头文件

请将以下代码添加到 AppDelegate.m 引用头文件的位置。

// 引入 JPush 功能所需头文件 # import "JPUSHService.h" // iOS10 注册 APNs 所需头文件 # ifdef NSFoundationVersionNumber_iOS_9_x_Max # import # endif // 如果需要使用 idfa 功能所需要引入的头文件(可选) # import
          // 引入 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 () @end
          @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|JPAuthorizationOptionProvidesAppNotificationSettings; if ([[UIDevice currentDevice].systemVersion floatValue] >= 8.0) { // 可以添加自定义 categories // NSSet *categories for iOS10 or later // NSSet *categories for iOS8 and iOS9 } [JPUSHService registerForRemoteNotificationConfig:entity delegate:self];
          //Required
//notice: 3.0.0 及以后版本注册可以这样写,也可以继续用之前的注册方式
JPUSHRegisterEntity * entity = [[JPUSHRegisterEntity alloc] init];
entity.types = JPAuthorizationOptionAlert|JPAuthorizationOptionBadge|JPAuthorizationOptionSound|JPAuthorizationOptionProvidesAppNotificationSettings;
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; if (@available(iOS 14, *)) { [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) { if (status == ATTrackingManagerAuthorizationStatusAuthorized) { advertisingId = [[ASIdentifierManager sharedManager] advertisingIdentifier].UUIDString; } }]; } else { // 使用原方式访问 IDFA advertisingId = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString]; } // Required // init Push // notice: 2.1.5 版本的 SDK 新增的注册方法,改成可上报 IDFA,如果没有使用 IDFA 直接传 nil [JPUSHService setupWithOption:launchOptions appKey:appKey channel:channel apsForProduction:isProduction advertisingIdentifier:advertisingId];
          // Optional
// 获取 IDFA
// 如需使用 IDFA 功能请添加此代码并在初始化方法的 advertisingIdentifier 参数中填写对应值
  NSString *advertisingId;
  if (@available(iOS 14, *)) {
        [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
            if (status == ATTrackingManagerAuthorizationStatusAuthorized) {
                advertisingId = [[ASIdentifierManager sharedManager] advertisingIdentifier].UUIDString;
            }
        }];
    } else {
        // 使用原方式访问 IDFA
        advertisingId = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];
    }

// Required
// init Push
// notice: 2.1.5 版本的 SDK 新增的注册方法,改成可上报 IDFA,如果没有使用 IDFA 直接传 nil
[JPUSHService setupWithOption:launchOptions appKey:appKey
                      channel:channel
             apsForProduction:isProduction
        advertisingIdentifier:advertisingId];

        
此代码块在浮窗中显示
部分参数说明:
  • appKey
    • 选择极光控制台的应用 ,点击“设置”获取其 appkey 值。请确保应用内配置的 appkey 与极光控制台上创建应用后生成的 appkey 一致。
  • channel
    • 指明应用程序包的下载渠道,为方便分渠道统计,具体值由你自行定义,如:App Store。
  • apsForProduction
    • 1.3.1 版本新增,用于标识当前应用所使用的 APNs 证书环境。
    • 0(默认值)表示采用的是开发证书,1 表示采用生产证书发布应用。
    • 注:此字段的值要与 Build Settings 的 Code Signing 配置的证书环境一致。
  • advertisingIdentifier

注册 APNs 成功并上报 DeviceToken

温馨提示:

JPush 3.0.9 之前的版本,必须调用此接口,注册 token 之后才可以登录极光,使用通知和自定义消息功能。
从 JPush 3.0.9 版本开始,不调用此方法也可以登录极光。但是不能使用 APNs 通知功能,只可以使用 JPush 自定义消息。

请在 AppDelegate.m 实现该回调方法并添加回调方法中的代码

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { /// Required - 注册 DeviceToken [JPUSHService registerDeviceToken:deviceToken]; }
          - (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); }
          - (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 12 Support - (void)jpushNotificationCenter:(UNUserNotificationCenter *)center openSettingsForNotification:(UNNotification *)notification{ if (notification && [notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) { //从通知界面直接进入应用 }else{ //从通知设置界面进入应用 } } // 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 iOS 6 [JPUSHService handleRemoteNotification:userInfo]; }
          # pragma mark- JPUSHRegisterDelegate

// iOS 12 Support
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center openSettingsForNotification:(UNNotification *)notification{
  if (notification && [notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
    //从通知界面直接进入应用
  }else{
    //从通知设置界面进入应用
  }
}

// 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 iOS 6
  [JPUSHService handleRemoteNotification:userInfo];
}

        
此代码块在浮窗中显示

添加处理 JPush 自定义消息回调方法

如需使用 JPush 的自定义消息功能,请参考 文档 来实现自定义消息的处理回调方法。

成功运行

真机调试该项目,如果控制台输出以下日志则代表您已经集成成功。

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

        
此代码块在浮窗中显示

如果调试运行中遇到问题请参考:iOS SDK 调试指南

高级功能

获取 Registration ID 交互建议

由于极光推送所有形式的推送最后都会转化为对 Registration ID 推送,因此排查客户问题的时候需要提供 Registration ID。为了方便线上客户准确提供信息,减少沟通成本,我们建议您完成 SDK 集成后,在 App 的【关于】、【意见反馈】、【我的】等比较不常用的 UI 中展示客户的 Registration ID 。

示例代码:

[JPUSHService registrationIDCompletionHandler:^(int resCode, NSString *registrationID) { NSLog(@"resCode : %d,registrationID: %@",resCode,registrationID); }];
          [JPUSHService registrationIDCompletionHandler:^(int resCode, NSString *registrationID) {
    NSLog(@"resCode : %d,registrationID: %@",resCode,registrationID);
}];

        
此代码块在浮窗中显示

效果如图:

关于 IDFA

r2.1.5 版本增加一个上传 IDFA 字符串的接口

+ (void)setupWithOption:(NSDictionary *)launchingOption appKey:(NSString *)appKey channel:(NSString *)channel apsForProduction:(BOOL)isProduction advertisingIdentifier:(NSString *)advertisingId;
           + (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;
          + (void)setupWithOption:(NSDictionary *)launchingOption
                  appKey:(NSString *)appKey
                 channel:(NSString *)channel
        apsForProduction:(BOOL)isProduction;

        
此代码块在浮窗中显示

JPush SDK 相关事件监听

建议开发者加上 API 里面提供的以下类型的通知:

extern NSString *const kJPFNetworkIsConnectingNotification; // 正在连接中

extern NSString * const kJPFNetworkDidSetupNotification; // 建立连接

extern NSString * const kJPFNetworkDidCloseNotification; // 关闭连接

extern NSString * const kJPFNetworkDidRegisterNotification; // 注册成功

extern NSString *const kJPFNetworkFailedRegisterNotification; //注册失败

extern NSString * const kJPFNetworkDidLoginNotification; // 登录成功

温馨提示:

Registration id 需要添加注册 kJPFNetworkDidLoginNotification 通知的方法里获取,也可以调用 [registrationIDCompletionHandler:] 方法,通过 completionHandler 获取

extern NSString * const kJPFNetworkDidReceiveMessageNotification; // 收到自定义消息(非 APNs)

其中,kJPFNetworkDidReceiveMessageNotification 传递的数据可以通过 NSNotification 中的 userInfo 方法获取,包括标题、内容、extras 信息等

请参考文档:iOS SDK API

通知展示统计

温馨提示:

iOS 10 新增的 Notification Service Extension 功能,用 mutable-content 字段来控制。
若使用 Web 控制台,需勾选 “可选设置”中 mutable-content 选项;若使用 RESTFul API 需设置 mutable-content 字段为 true。

从 iOS JPush SDK 3.0.7 版本,开发者可使用 Notification Service Extension SDK 上报每条 APNs 信息展示的状态。

使用方法:

  • 创建一个 Service Extension 服务,详情参考 iOS 10 Service Extension
  • Cocoapods 导入
    pod 'JPushExtension'
              pod 'JPushExtension'
    
            
    此代码块在浮窗中显示
  • 调用 [jpushSetAppkey:] 方法设置您的 appkey,请注意这里的 appkey 应该和您极光应用的 appkey 相同。
  • 调用 [jpushReceiveNotificationRequest:] 方法上报您的 apns 消息,完成展示统计;在该方法的 block 回调中进行 apns 的显示。
# import "NotificationService.h" # import "JPushNotificationExtensionService.h" @implementation NotificationService - (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler { - [JPushNotificationExtensionService jpushSetAppkey:@"AppKey copied from JiGuang Portal application"]; [JPushNotificationExtensionService jpushReceiveNotificationRequest:request with:^ { NSLog(@"apns upload success"); contentHandler(request.content); }]; } @end
          # import "NotificationService.h"
# import "JPushNotificationExtensionService.h"

@implementation NotificationService

- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
-
  [JPushNotificationExtensionService jpushSetAppkey:@"AppKey copied from JiGuang Portal application"];
  [JPushNotificationExtensionService jpushReceiveNotificationRequest:request with:^ {
    NSLog(@"apns upload success");
    contentHandler(request.content);
  }];

}

@end

        
此代码块在浮窗中显示

Voip 推送

  • 在 iOS 8 之后引入了一个基于 PushKit 框架的 Voip 推送,可以使得用户的 APP 在杀死的情况下唤醒 APP,并执行代码。
  • Voip 不区分开发和生产证书,Apple Push Notification service SSL (Sandbox & Production) 和 VoIP Services Certificate 都支持 Voip 推送

添加 PushKit.Framework 库

  • 以 optional 方式引入 PushKit.framework 库
  • 导入头文件 #import <PushKit/PushKit.h>
  • AppDelegate 实现 PKPushRegistryDelegate 协议

添加 Voip 权限

在 Project-> Capabilities->Background Modes 里把 Voice over IP 选项打开

代码实现

  • 在 didFinishLaunchingWithOptions 方法中实现 Voip 注册
- (void)voipRegistration{ dispatch_queue_t mainQueue = dispatch_get_main_queue(); PKPushRegistry *voipRegistry = [[PKPushRegistry alloc] initWithQueue:mainQueue]; voipRegistry.delegate = self; // Set the push type to VoIP voipRegistry.desiredPushTypes = [NSSet setWithObject:PKPushTypeVoIP]; }
          - (void)voipRegistration{
  dispatch_queue_t mainQueue = dispatch_get_main_queue();
  PKPushRegistry *voipRegistry = [[PKPushRegistry alloc] initWithQueue:mainQueue];
  voipRegistry.delegate = self;
  // Set the push type to VoIP
  voipRegistry.desiredPushTypes = [NSSet setWithObject:PKPushTypeVoIP];
}

        
此代码块在浮窗中显示
  • 提交 Token
/// 系统返回VoipToken,上报给极光服务器 - (void)pushRegistry:(PKPushRegistry *)registry didUpdatePushCredentials:(PKPushCredentials *)pushCredentials forType:(PKPushType)type{ [JPUSHService registerVoipToken:pushCredentials.token]; }
          /// 系统返回VoipToken,上报给极光服务器
- (void)pushRegistry:(PKPushRegistry *)registry didUpdatePushCredentials:(PKPushCredentials *)pushCredentials forType:(PKPushType)type{
    [JPUSHService registerVoipToken:pushCredentials.token];
}

        
此代码块在浮窗中显示
  • 接收到 Voip 推送,调用回执接口,用户统计 Voip 送达。
- (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type{ // 提交回执给极光服务器 [JPUSHService handleVoipNotification:payload.dictionaryPayload]; } - (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type withCompletionHandler:(void(^)(void))completion{ // 提交回执给极光服务器 [JPUSHService handleVoipNotification:payload.dictionaryPayload]; }
          - (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type{
  // 提交回执给极光服务器
  [JPUSHService handleVoipNotification:payload.dictionaryPayload];
}

- (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type withCompletionHandler:(void(^)(void))completion{
  // 提交回执给极光服务器
  [JPUSHService handleVoipNotification:payload.dictionaryPayload];
}

        
此代码块在浮窗中显示

技术支持

当出现问题时:

  • 请仔细阅读 iOS FAQ 文档,查看是否有遗漏。
  • 你可以到极光社区搜索类似问题
  • 给我们的 support 发邮件 [support@jiguang.cn][4]

为了更快速的解决问题,在寻求帮助时,请提供下列信息:

  • 你需要咨询的产品是 JPush,是否同时使用了极光其他的产品
  • 你所调用的是什么 API,所传参数,完整的报错信息,出现异常的时间点
  • 如果收不到消息,提供应用的 Appkey,消息的 Message ID,设备的 registration ID 信息
  • 如果是 SDK 问题请提供对应的 SDK 版本和完整的日志记录,日志信息请使用 TXT 文件上传
  • 出现异常的设备是 iOS ,列出具体的机型和系统
文档内容是否对您有帮助?

Copyright 2011-2022, jiguang.cn, All Rights Reserved. 粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

在文档中心打开