TIMConvGetConversationListByFilter
Introduction
Get conversation list by filter
Supported from the 6.5 version of the sdk
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| convListByFilterparam | TIMConversationListFilter | yes | Param of getting conversation list by filter |
Returned template
Promise<commonResult<TIMConversationListResult>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: TIMConversationListResult | undefined;
json_params?: TIMConversationListResult | 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 | TIMConversationListResult ｜ undefined | Return value of calling API |
| json_params | TIMConversationListResult ｜ 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();
let param: TIMConversationListFilter = {
params: {
conversation_list_filter_conv_type: 2,
conversation_list_filter_next_seq: 0,
conversation_list_filter_count: 20,
conversation_list_filter_mark_type: 0x1,
},
user_data: ""
}
timRenderInstance.TIMConvGetConversationListByFilter(param)