TIMFriendshipAddToBlackList
功能介绍
添加指定用户到黑名单
被拉黑的用户默认不会感知到 “被拉黑” 的状态，消息发送后不会返回已被对方拉黑的错误码。
如果希望被拉黑的用户在发消息时返回已被对方拉黑的错误提醒，请在 即时通信 IM 控制台 >【功能配置】>【登录与消息】>【黑名单检查】中关闭 ”发送消息后展示发送成功“。关闭后，被拉黑的用户在发送消息时，SDK 会报 20007 错误码。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| friendshipStringArrayParams | FriendshipStringArrayParams | 是 | 添加指定用户到黑名单的参数 |
返回模板
Promise<commonResult<Array<FriendResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<FriendResult> | undefined;
json_params?: Array<FriendResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | Array< FriendResult > ｜ undefined | 根据具具体接口返回 |
| json_params | Array< FriendResult > ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { FriendshipStringArrayParams } from "im_electron_sdk/dist/interfaces";
let param:FriendshipStringArrayParams={
params: [""], //必填
user_data: "" //选填
}
const {code} = await timRenderInstance.TIMFriendshipAddToBlackList(param);
if(code == 0){
// 成功
}