TIMFriendshipDeleteFriend
Introduction
Delete friend
Friend deletion has two types, unidirectional/bidirectional. Deleting friends.
friendship_delete_friend_param_identifier_array length maximum 100, for too much data in one package the connection may be rejected for the maximum size of data package is 1M.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| deleteFriendParams | DeleteFriendParams | yes | Param of deleting friend |
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 { DeleteFriendParams } from "im_electron_sdk/dist/interfaces";
let param: DeleteFriendParams = {
params: {
friendship_delete_friend_param_friend_type: 1,
friendship_delete_friend_param_identifier_array: [""]
},
user_data: "" // optional
}
const { code } = await timRenderInstance.TIMFriendshipDeleteFriend(param);
if (code == 0) {
// success
}