TIMFriendshipAddToBlackList
Introduction
Add to blacklist
To block a user's messages, add the user to the blocklist.
Blocked user won't be notified by default, and he/she can still send messages without any error code returned.
If you wish to return certain error codes, please go to IM Console >【Feature Configuration】>【Login and Message】>【Blocklist Check】and disable Show "Sent successfully" After Sending Messages. Then SDK will return 20007 error code when blocked user sends messages.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| friendshipStringArrayParams | FriendshipStringArrayParams | yes | Param of adding to blacklist |
Returned template
Promise<commonResult<Array<FriendResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<FriendResult> | undefined;
json_params?: Array<FriendResult> | undefined;
user_data?: string | undefined;
}
Return value details
| name | type | description |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | Request result: Error codes. 0 means success. |
| desc | string ｜ undefined | The description of the error. It will be empty if success. |
| json_param | Array< FriendResult > ｜ undefined | Return value of calling API |
| json_params | Array< FriendResult > ｜ undefined | Return value of calling API. Compatible field, which is returned in some cases. |
| user_data | string ｜ undefined | ImSDK is responsible for transporting user-defined data without any processing |
Code example
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { FriendshipStringArrayParams } from "im_electron_sdk/dist/interfaces";
let param: FriendshipStringArrayParams = {
params: [""], // required
user_data: "" // optional
}
const { code } = await timRenderInstance.TIMFriendshipAddToBlackList(param);
if (code == 0) {
// success
}