MsgDownloadElemToPath
功能介绍
下载多媒体消息
此接口用于下载消息内图片、文件、声音、视频等元素。下载的参数 msg_download_elem_param_flag、msg_download_elem_param_id、msg_download_elem_param_business_id、msg_download_elem_param_url 均可以在相应元素内找到。其中 msg_download_elem_param_type 为下载文件类型 TIMDownloadType，参数 path 要求是 UTF-8 编码
参数详解
重载1
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| download_param | DownloadElemParam | 是 | 下载参数 |
| path | string | 是 | 本地路径 |
| callback | ValueCallback< MsgDownloadElemResult > | 是 | 异步回调 返回值的json_param的格式为json |
重载2
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| download_param | DownloadElemParam | 是 | 下载参数 |
| path | string | 是 | 本地路径 |
| callback | ValueCallback< string > | 是 | 异步回调 返回值的json_param的格式为string |
返回模板
TIMResult
调用成功后回调函数参数：
code:int
desc:string
json_param:
'{
"msg_download_elem_result_current_size" : 10,
"msg_download_elem_result_total_size" : 100
}' // Json Key请参考[MsgDownloadElemResult]
user_data:string
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| TIMResult | TIMResult | 调用接口的返回值 |
| code | int | 值为ERR_SUCC表示成功，其他值表示失败。详情请参考 错误码 |
| desc | string | 错误描述字符串 |
| json_param | string | Json字符串，不同的接口，Json字符串不一样 Json Key请参考MsgDownloadElemResult |
| user_data | string | ImSDK负责透传的用户自定义数据，未做任何处理 |