TIMConvDeleteConversationList
Introduction
Delete conversation list
Up to 100 sessions can be deleted each time
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| DeleteConvListParam | DeleteConvListParam | yes | Delete conversation list param |
Returned template
Promise<commonResult<Array<TIMConversationOperationResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<TIMConversationOperationResult>| undefined;
json_params?: Array<TIMConversationOperationResult> | 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< TIMConversationOperationResult > ｜ undefined | Return value of calling API |
| json_params | Array< TIMConversationOperationResult > ｜ undefined | Return value of calling API. Compatible field, which is returned in some cases. |
| user_data | string ｜ undefined | mSDK is responsible for transporting user-defined data without any processing |
Code example
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
let param:DeleteConvListParam = {
conversation_id_array: [
"c2c_test",
],
clearMessage: false
}
timRenderInstance.TIMConvDeleteConversationList(param)