# Interface: DownloadFileParams ‹Err›
• DownloadFileParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# Optional filePath
• filePath? : string
指定文件下载后存储的路径 (本地路径)
Returns: string
# Optional header
• header? : Record‹string, string | string[]›
HTTP 请求的 Header，Header 中不能设置 Referer
Returns: Record‹string, string | string[]›
# Optional timeout
• timeout? : number
超时时间，单位为毫秒
Returns: number
# url
• url: string
下载资源的 url
Returns: string
# Methods
# Optional complete
▸ complete(res: DownloadFileRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数（调用成功、失败都会执行）
# 参数:
| 属性 | 类型 |
|---|---|
res | DownloadFileRes | Err |
# 返回值:
void
# Optional fail
▸ fail(err: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
| 属性 | 类型 |
|---|---|
err | Err |
# 返回值:
void
# Optional success
▸ success(res: DownloadFileRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
| 属性 | 类型 |
|---|---|
res | DownloadFileRes |
DownloadFileRes
| 属性 | 类型 | 描述 |
|---|---|---|
errMsg | string | API 调用成功/失败的消息 |
filePath | string | 用户文件路径 (本地路径)。 传入 filePath 时会返回，跟传入的 filePath 一致 |
profile | Profile | 网络请求过程中一些调试信息 |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
tempFilePath | string | 临时文件路径 (本地路径)。 没传入 filePath 指定文件存储路径时会返回，下载后的文件会存储到一个临时文件 |
# 返回值:
void