TIMMsgFindMessages
Introduction
Search local message
Only local messages can be queried, for example, received messages or historical messages pulled by API.
Audio-video group (AVChatRoom) messages cannot be queried, as they are not saved locally.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| msgFindMessagesParams | MsgFindMessagesParams | yes | Param of searching local message |
Returned template
Promise<commonResult<Array<Json_value_msg>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<Json_value_msg> | undefined;
json_params?: Array<Json_value_msg> | 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< Json_value_msg > ｜ undefined | Return value of calling API |
| json_params | Array< Json_value_msg > ｜ 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 { MsgFindMessagesParams } from "im_electron_sdk/dist/interfaces";
let messageId = ''
let param: MsgFindMessagesParams = {
json_message_id_array: [messageId],
user_data: ''
}
const { code } = await timRenderInstance.TIMMsgFindMessages(param);
if (code == 0) {
// success
}