APNs 离线推送

这是本文档旧的修订版！

1. 后台上传了推送证书，具体步骤见集成 iOS SDK 前的准备工作-制作并上传推送证书。

2. 代码配置 APNs 使用的推送证书。

EMOptions *options = [EMOptions optionsWithAppkey:@"appkey"];
options.apnsCertName = @"apnsCertName";
[[EMClient sharedClient] initializeSDKWithOptions:options];

3. 代码注册离线推送。

UIApplication *application = [UIApplication sharedApplication];

//iOS10 注册APNs
if (NSClassFromString(@"UNUserNotificationCenter")) {
    [[UNUserNotificationCenter currentNotificationCenter] requestAuthorizationWithOptions:UNAuthorizationOptionBadge | UNAuthorizationOptionSound | UNAuthorizationOptionAlert completionHandler:^(BOOL granted, NSError *error) {
        if (granted) {
#if !TARGET_IPHONE_SIMULATOR
            [application registerForRemoteNotifications];
#endif
        }
    }];
    return;
}

if([application respondsToSelector:@selector(registerUserNotificationSettings:)])
{
    UIUserNotificationType notificationTypes = UIUserNotificationTypeBadge | UIUserNotificationTypeSound | UIUserNotificationTypeAlert;
    UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:notificationTypes categories:nil];
    [application registerUserNotificationSettings:settings];
}

#if !TARGET_IPHONE_SIMULATOR
if ([application respondsToSelector:@selector(registerForRemoteNotifications)]) {
    [application registerForRemoteNotifications];
}else{
    UIRemoteNotificationType notificationTypes = UIRemoteNotificationTypeBadge |
    UIRemoteNotificationTypeSound |
    UIRemoteNotificationTypeAlert;
    [[UIApplication sharedApplication] registerForRemoteNotificationTypes:notificationTypes];
}
#endif

您注册了推送功能，iOS 会自动回调以下方法，得到 deviceToken，您需要将 deviceToken 传给 SDK。

如果是iOS13及以上的系统，请将SDK更新到v3.6.2及以上版本

// 将得到的deviceToken传给SDK
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        [[EMClient sharedClient] bindDeviceToken:deviceToken];
    });
}

// 注册deviceToken失败
- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error{
    NSLog(@"error -- %@",error);
}

注：必须是真机，模拟器不支持APNs。APNs 注册失败，一般是由于使用了通用证书或者是模拟器调试导致，请检查证书并用真机调试。此处是 iOS 系统报的错，如仍不能确定，请从网上查找相关资料。

APNs 属性需要从服务器获取端获取。

登录成功后调用。

/*!
 *  从服务器获取推送属性
 *
 *  @param aCompletionBlock 完成的回调
 */
- (void)getPushNotificationOptionsFromServerWithCompletion:(void (^)(EMPushOptions *aOptions, EMError *aError))aCompletionBlock;

// 调用:
[[EMClient sharedClient] getPushNotificationOptionsFromServerWithCompletion:^(EMPushOptions *aOptions, EMError *aError) {
    if(!aError){
        NSLog(@"从服务器获取推送属性成功");
    } else {
        NSLog(@"从服务器获取推送属性失败的原因 --- %@", aError.errorDescription);
    }
}];

提供三种方法。可以配置 APNs 免打扰时间、APNs 昵称、推送样式。EMPushNotificationOptions 中的属性传入你想设置的值，调用以下方法即可。

以下方法会将 options 参数中的所有属性都更新到服务器上，请确保传入的 options 参数中的配置符合你的要求。

登录成功后调用。

/*!
 *  更新推送设置到服务器
 *
 *  @param aCompletionBlock 完成的回调
 */
- (void)updatePushNotificationOptionsToServerWithCompletion:(void (^)(EMError *aError))aCompletionBlock;

// 调用:
[[EMClient sharedClient] updatePushNotificationOptionsToServerWithCompletion:^(EMError *aError) {
    if(!aError){
        NSLog(@"更新推送设置到服务器成功");
    } else {
        NSLog(@"更新推送设置到服务器失败的原因 --- %@", aError.errorDescription);
    }
}];

设置当前登录用户的 APNs 昵称。

登录成功后设置。

[[EMClient sharedClient] setApnsNickname:@"推送昵称"];

登录成功后设置。

EMPushOptions *options = [[EMClient sharedClient] pushOptions];
options.displayStyle = EMPushDisplayStyleMessageSummary // 显示消息内容
// options.displayStyle = EMPushDisplayStyleSimpleBanner // 显示“您有一条新消息”
[[EMClient sharedClient] updatePushNotificationOptionsToServerWithCompletion:^(EMError *aError) {
    if(!aError){
        NSLog(@"更新推送设置到服务器成功");
    } else {
        NSLog(@"更新推送设置到服务器失败的原因 --- %@", aError.errorDescription);
    }
}];

需登录成功。

/*!
 *  屏蔽/取消屏蔽群组消息的推送
 *
 *  @param aGroupId          群组ID
 *  @param aIsEnable         是否允许推送
 *  @param aCompletionBlock  完成的回调
 */
- (void)updatePushServiceForGroup:(NSString *)aGroupId
                    isPushEnabled:(BOOL)aIsEnable
                       completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock;

// 调用:
[[EMClient sharedClient].groupManager updatePushServiceForGroup:@"groupId" isPushEnabled:NO completion:^(EMGroup *aGroup, EMError *aError) {
    if (!aError) {
        NSLog(@"屏蔽群组消息的推送成功");
    } else {
        NSLog(@"屏蔽群组消息的推送失败的原因 --- %@", aError.errorDescription);
    } 
}];

批量指定群组是否接收 APNs

/*!
 *  屏蔽/取消屏蔽群组消息的推送
 *
 *  @param aGroupIDs         群组ID列表
 *  @param aIsEnable         是否允许推送
 *  @param aCompletionBlock  完成的回调
 */
- (void)updatePushServiceForGroups:(NSArray *)aGroupIDs
                     isPushEnabled:(BOOL)aIsEnable
                        completion:(void (^)(NSArray *groups, EMError *aError))aCompletionBlock;
                       
// 调用:
[[EMClient sharedClient].groupManager updatePushServiceForGroups:@[@"groupId1"] isPushEnabled:YES completion:^(NSArray *groups, EMError *aError) {
    if (!aError) {
        NSLog(@"取消屏蔽群组消息的推送成功");
    } else {
        NSLog(@"取消屏蔽群组消息的推送失败的原因 --- %@", aError.errorDescription);
    } 
}];

在获取屏蔽了推送的群组ID列表之前，要先从环信服务器获取推送配置属性，SDK会将屏蔽了推送的群组ID列表加载到内存后，才能拿到“屏蔽了推送的群组ID列表”

/*!
 *  从服务器获取推送属性
 *
 *  @param aCompletionBlock 完成的回调
 */
- (void)getPushNotificationOptionsFromServerWithCompletion:(void (^)(EMPushOptions *aOptions, EMError *aError))aCompletionBlock;

// 调用:
[[EMClient sharedClient] getPushNotificationOptionsFromServerWithCompletion:^(EMPushOptions *aOptions, EMError *aError) {
    if (!aError) {
        NSLog(@"从服务器获取推送属性成功");
    } else {
        NSLog(@"从服务器获取推送属性失败的原因 --- %@", aError.errorDescription);
    } 
}];

/*!
 *  从内存中获取屏蔽了推送的群组ID列表
 *
 *  @param pError  错误信息
 *  @param pError  Error
 */
- (NSArray *)getGroupsWithoutPushNotification:(EMError **)pError;

// 调用:
EMError *error;
NSArray *groupIds = [[EMClient sharedClient].groupManager getGroupsWithoutPushNotification:&error];
if (!error) {
    NSLog(@"获取屏蔽了推送的群组ID列表成功 --- %@", groupIds);
} else {
    NSLog(@"获取屏蔽了推送的群组ID列表失败的原因 --- %@", aError.errorDescription);
}

登录成功后设置。

/*!
 @enum
 @brief 推送免打扰设置的状态
 @constant EMPushNoDisturbStatusDay     全天免打扰
 @constant EMPushNoDisturbStatusCustom  自定义时间段免打扰
 @constant EMPushNoDisturbStatusClose   关闭免打扰模式
 */
typedef NS_ENUM(NSInteger, EMPushNoDisturbStatus) {
    EMPushNoDisturbStatusDay = 0,
    EMPushNoDisturbStatusCustom,
    EMPushNoDisturbStatusClose,
};

// 设置全天免打扰，设置后，您将收不到任何推送
EMPushOptions *options = [[EMClient sharedClient] pushOptions];
options.noDisturbStatus = EMPushNoDisturbStatusDay;
options.noDisturbingStartH = 0;
options.noDisturbingEndH = 24;
[[EMClient sharedClient] updatePushNotificationOptionsToServerWithCompletion:^(EMError *aError) {
    if(!aError){
        NSLog(@"更新推送设置到服务器成功");
    } else {
        NSLog(@"更新推送设置到服务器失败的原因 --- %@", aError.errorDescription);
    }
}];


// 设置免打扰时段，设置后，在改时间内不收推送
EMPushOptions *options = [[EMClient sharedClient] pushOptions];
options.noDisturbStatus = EMPushNoDisturbStatusCustom;
options.noDisturbingStartH = 9;
options.noDisturbingEndH = 22;
[[EMClient sharedClient] updatePushNotificationOptionsToServerWithCompletion:^(EMError *aError) {
    if(!aError){
        NSLog(@"更新推送设置到服务器成功");
    } else {
        NSLog(@"更新推送设置到服务器失败的原因 --- %@", aError.errorDescription);
    }
}];

上一页：APNs推送配置

下一页：APNs 内容解析

APNs 离线推送

必备条件

获取全局 APNs 配置

设置 APNs 全局属性

单独设置 APNs 昵称

设置推送显示详情

设置指定群组是否接收 APNs

获取不接收 APNs 的群组 ID

全局免打扰设置