MsgSearchLocalMessages
introduction
Search local message
Only local messages can be searched for, for example, received messages or historical messages obtained after the API is called.
If you want to search all the conversations, you only need to leave msg_search_param_conv_id in MessageSearchParam empty (null) or unspecified.
Ultimate package only, Buy Ultimate package to enable it.
Parameter details
overload1
Parameter name | Parameter type | Required | Description |
---|---|---|---|
message_search_param | MessageSearchParam | Required | Search message param |
callback | ValueCallback< MessageSearchResult > | Required | Asynchronous callback The format of json_param in the return value is json |
overload2
Parameter name | Parameter type | Required | Description |
---|---|---|---|
message_search_param | MessageSearchParam | Required | Search message param |
callback | ValueCallback< string > | Required | Asynchronous callback The format of json_param in the return value is string |
Returned template
TIMResult
The parameters of the callback function after successfully calling the API:
code:int
desc:string
json_param:MessageSearchResult
user_data:string
Return value details
name | type | description |
---|---|---|
TIMResult | TIMResult | Return value of calling API |
code | int | Result error code: Error Codes |
desc | string | The description of the error. |
json_param | string | Json string. Calling different API will get different Json strings. |
user_data | string | User-defined data transfered by ImSDK without any processing |