TIMConvDelete
Introduction
Delete conversation
After deleting friend or quitting group, if no need to check history message, you may delete the conversation.
Conversation deletion is not multi-device synchronized by default, you may enable synchronization on IM Console.
Delete conversation will erase history message locally and cloudily and non-recoverable.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| param | convDelete | yes | Param of deleting conversation |
Returned template
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | 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 | string ｜ undefined | Return value of calling API |
| json_params | string ｜ 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 { convDelete } from "im_electron_sdk/dist/interfaces";
let convID = ""
let convType = 0
let param: convDelete = {
convId: convID, // required， convID
convType: convType, // required，convType，参考[TIMConvType]
userData: "", // optional
}
let { code } = await timRenderInstance.TIMConvDelete(param)
if (code == 0) {
// 删除成功
}