MsgSearchLocalMessages
功能介绍
搜索本地消息
消息搜索只能搜索本地存储的消息,比如接收到的消息、调用拉取历史消息接口得到的消息等。
如果您希望在全部会话范围内搜索,只需要将 MessageSearchParam 中的 msg_search_param_conv_id 设置为空(null) 或者不设置即可。
该功能为 IM 旗舰版功能,购买旗舰版套餐包后可使用,详见价格说明。
参数详解
重载1
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
message_search_param | MessageSearchParam | 是 | 搜索消息参数 |
callback | ValueCallback< MessageSearchResult > | 是 | 异步回调 返回值的json_param的格式为json |
重载2
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
message_search_param | MessageSearchParam | 是 | 搜索消息参数 |
callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:MessageSearchResult
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样 |
user_data | string | ImSDK负责透传的用户自定义数据,未做任何处理 |