TIMMsgClearHistoryMessage
Introduction
Clear history message
When messages in a conversation are cleared, all the messages in the conversation will be cleared both locally and from the cloud, but the conversation itself will not be deleted.
Do not use this API if you do not want to clear messages from the cloud.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| msgClearHistoryMessageParams | MsgClearHistoryMessageParams | yes | Param of clearing history message |
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 { MsgClearHistoryMessageParams } from "im_electron_sdk/dist/interfaces";
let convId = ''
let convType = 0
let param: MsgClearHistoryMessageParams = {
conv_id: convId,
conv_type: convType,
user_data: ''
}
const { code } = await timRenderInstance.TIMMsgClearHistoryMessage(param);
if (code == 0) {
// success
}