跳转至

免打扰

提示

  1. 单个会话免打扰,可以屏蔽某个会话的通知提醒和推送。
  2. 所有会话免打扰。可以屏蔽某一个时间段免打扰,也可以设置全天免打扰。

单个会话免打扰

设置

注意

如果开发者使用 IMLib,此方法会屏蔽该会话的远程推送;如果开发者使用 IMKit,此方法会屏蔽该会话的所有提醒(远程推送、本地通知、前台提示音)。

参数 类型 说明
conversationType RCConversationType(枚举) 会话类型
targetId NSString 目标会话 Id
isBlocked BOOL 是否屏蔽消息提醒
successBlock void 设置成功的回调 [nStatus: 会话设置的消息提醒状态]
errorBlock block 设置失败的回调 [status: 设置失败的错误码]
- (void)setConversationNotificationStatus:(RCConversationType)conversationType
                                 targetId:(NSString *)targetId
                                isBlocked:(BOOL)isBlocked
                                  success:(void (^)(RCConversationNotificationStatus nStatus))successBlock
                                    error:(void (^)(RCErrorCode status))errorBlock;

查询

参数 类型 说明
conversationType RCConversationType(枚举) 会话类型
targetId NSString 目标会话 Id
successBlock void 查询成功的回调 [nStatus: 会话设置的消息提醒状态]
errorBlock void 查询失败的回调 [status: 设置失败的错误码]
- (void)getConversationNotificationStatus:(RCConversationType)conversationType
                                 targetId:(NSString *)targetId
                                  success:(void (^)(RCConversationNotificationStatus nStatus))successBlock
                                    error:(void (^)(RCErrorCode status))errorBlock;

获取

参数 类型 说明
conversationTypeList NSArray 会话类型的数组(需要将 RCConversationType 转为 NSNumber 构建 Array)。
返回值 NSArray 屏蔽消息提醒的会话 RCConversation 的列表。
- (NSArray<RCConversation *> *)getBlockedConversationList:(NSArray *)conversationTypeList;

所有会话免打扰

设置

提示

  1. 此方法设置的屏蔽时间会在每天该时间段时生效。
  2. 如果开发者使用 IMLib,此方法会屏蔽该会话在该时间段的远程推送;如果开发者使用IMKit,此方法会屏蔽该会话在该时间段的所有提醒(远程推送、本地通知、前台提示音)。
参数 类型 说明
startTime NSString 开始屏蔽消息提醒的时间,格式为HH:MM:SS
spanMins int 需要屏蔽消息提醒的分钟数,0 < spanMins 且 spanMins < 1440
successBlock void 屏蔽成功的回调
errorBlock void 屏蔽失败的回调 [status: 屏蔽失败的错误码]
- (void)setNotificationQuietHours:(NSString *)startTime
                         spanMins:(int)spanMins
                          success:(void (^)(void))successBlock
                            error:(void (^)(RCErrorCode status))errorBlock;

查询

参数 类型 说明
successBlock void 屏蔽成功的回调 [startTime: 已设置的屏蔽开始时间, spansMin: 已设置的屏蔽时间分钟数,0 < spansMin 且 spansMin < 1440]
errorBlock void 查询失败的回调 [status: 查询失败的错误码]
- (void)getNotificationQuietHours:(void (^)(NSString *startTime, int spansMin))successBlock
                            error:(void (^)(RCErrorCode status))errorBlock;

删除

参数 类型 说明
successBlock void 删除屏蔽成功的回调
errorBlock void 删除屏蔽失败的回调 [status: 失败的错误码]
- (void)removeNotificationQuietHours:(void (^)(void))successBlock error:(void (^)(RCErrorCode status))errorBlock;