downloadFile
downloadFile là API dùng để dowload file về máy. File sẽ được lưu trữ tạm ở device.
Lưu ý
Bạn vẫn có thể sử dụng request để download dữ liệu, tuy nhiên api request chỉ trả về raw data của file. Khác với request, downloadFile sẽ thực hiện download về lưu file; sau đó trả về đường dẫn tạm thời có thể truy cập lại file bất cứ lúc nào.
Tham số
Để cấu hình việc gọi network, bạn cần truyền object với các thuộc tính sau:
| Thuộc tính | Kiểu dữ liệu | Bắt buộc | Mô tả |
|---|---|---|---|
| url | string | ✓ | Đường dẫn của file muốn download |
| headers | Object | Cấu hình headers khi thực hiện gọi network. | |
| success | Function | Callback function khi việc download file thành công. | |
| fail | Function | Callback function khi việc download file thất bại. | |
| complete | Function | Callback function khi việc download file kết thúc cho dù thành công hay thất bại. |
Success Callback function payload
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
| filePath | string | Đường dẫn của file sau khi download |
Ví dụ
Example bên dưới nhập vào 1 url để download file
import apis from '@v-miniapp/apis'
function onDownloadFile() {
apis.downloadFile({
url: this.data.url,
headers: {},
success: res => {
apis.alert({ title: JSON.stringify(res) })
},
fail: e => {
console.log(e)
},
})
}