黑名单管理

更新时间:

本文主要介绍 云上曲率即时通讯IM SDK的黑名单管理功能。

功能描述

黑名单管理是指用户可以添加好友用户为黑名单用户，也可以将好友从黑名单中移除。

云上曲率IM SDK为开发者提供如下黑名单管理内容：

  • 获取黑名单列表
  • 添加黑名单用户
  • 移除黑名单用户

接口说明

获取黑名单列表

用户可以通过getBlackList接口获取到自己的黑名单用户列表。

接口参数说明：

参数 含义 说明
timeout 超时时间 请求的超时时间，单位为秒
代码示例
-(void)getBlacklist:(int)timeout
            success:(void(^)(NSArray * _Nullable uidsArray))successCallback
               fail:(IMAnswerFailCallBack)failCallback;

添加黑名单用户

用户可以通过addBlackList接口添加其他用户到黑名单。

添加到黑名单之后，用户可以给黑名单用户发送信息，但黑名单用户无法给用户发消息。

注意：可以添加黑名单的用户的前提是该用户和添加者是好友关系。

接口参数说明：

参数 含义 说明
friendids 好友ID 待添加黑名单的好友ID
timeout 超时时间 请求的超时时间，单位为秒
代码示例
-(void)addBlacklist:(NSArray <NSNumber* >* _Nonnull)friendids
            timeout:(int)timeout
            success:(void(^)(void))successCallback
               fail:(IMAnswerFailCallBack)failCallback;

移除黑名单用户

用户可以通过deleteBlackList接口移除黑名单用户。

从黑名单列表中移除之后，用户之间的关系恢复为好友关系。

注意：如果用户B从用户A的黑名单中移除，那么在黑名单时期用户B发送给用户A的消息，不会出现在会话历史消息中。

接口参数说明：

参数 含义 说明
friendIds 好友ID 待移出黑名单的好友ID
timeout 超时时间 请求的超时时间，单位为秒
代码示例
-(void)deleteBlacklist:(NSArray <NSNumber* >* _Nonnull)friendids
               timeout:(int)timeout
               success:(void(^)(void))successCallback
                  fail:(IMAnswerFailCallBack)failCallback;