TIMConvGetConvInfo
Introduction
Get conversation info
The IM SDK provides an API for getting conversations, which you can use to get the ConvInfo object information of one or multiple specified conversations.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| param | convGetConvInfo | yes | Param of getting conversation info |
Returned template
Promise<commonResult<Array<convInfo>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<convInfo> | undefined;
json_params?: Array<convInfo> | 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< convInfo > ｜ undefined | Return value of calling API |
| json_params | Array< convInfo > ｜ 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 { convItem, convGetConvInfo } from "im_electron_sdk/dist/interfaces";
let convID = ""
let convType = 0
let conv_item: convItem = {
get_conversation_list_param_conv_id: convID, // required
get_conversation_list_param_conv_type: convType // required
}
let param: convGetConvInfo = {
json_get_conv_list_param: [conv_item], // required
user_data: "", // optional
}
let { code } = await timRenderInstance.TIMConvGetConvInfo(param)
if (code == 0) {
// success
}