download

2022-06-13 14:14 更新

下載文件

download({params}, callback(ret, err))

params

url:

  • 類型:字符串
  • 默認值:無
  • 描述:下載地址

encode:

  • 類型:布爾
  • 默認值:true
  • 描述:(可選項)是否對url進行編碼。默認或傳true時,Android將始終對url編碼,而iOS只有在url不合法(如存在中文字符)的時候才進行編碼。如果url中有特殊字符需要編碼的,建議先在js層進行編碼,然后此參數(shù)傳false。

savePath:

  • 類型:字符串
  • 默認值:無
  • 描述:(可選項)存儲路徑,不傳時使用自動創(chuàng)建的路徑

report:

  • 類型:布爾類型
  • 默認值:false
  • 描述:(可選項)下載過程是否上報

cache:

  • 類型:布爾類型
  • 默認值:true
  • 描述:(可選項)是否使用本地緩存

allowResume:

  • 類型:布爾類型
  • 默認值:false
  • 描述:(可選項)是否允許斷點續(xù)傳

method:

  • 類型:字符串

  • 默認值:get

  • 描述:(可選項)請求方法類型

  • 取值范圍:

  get
  post

headers:

  • 類型:JSON 對象
  • 默認值:無
  • 描述:(可選項)設置請求頭數(shù)據(jù)

data:

  • 類型:JSON 對象
  • 默認值:無
  • 描述:(可選項)POST 數(shù)據(jù),method 為 get 時不傳。values 和 body 不能同時使用。
  • 內(nèi)部字段:

{
    body:"",    //以純文本的方式提交數(shù)據(jù),body 支持字符串及 JSON 對象(若要校驗數(shù)據(jù)完整性,需將 JSON 對象轉(zhuǎn)換成字符串再傳入)。提交 JSON 對象時,需設置 application/json 類型的 Content-Type 頭
    values:{},  //以表單方式提交參數(shù)(JSON 對象), 如 {"field1": "value1", "field1": "value2"} (直接傳 JSON 對像.)
}

callback(ret, err)

ret:

  • 類型:JSON 對象
  • 內(nèi)部字段:

{
    fileSize:0,                 //文件大小,數(shù)字類型
    percent:0,                  //下載進度(0-100),數(shù)字類型
    state:0,                    //下載狀態(tài),數(shù)字類型。(0:下載中、1:下載完成、2:下載失?。?    savePath:''                 //存儲路徑(字符串類型)
}

err:

  • 類型:JSON 對象
  • 內(nèi)部字段:

{
    msg:""    //錯誤描述
}

示例代碼

api.download({
    url: url,
    savePath: 'fs://test.rar',
    report: true,
    cache: true,
    allowResume: true
}, function(ret, err) {
    if (ret.state == 1) {
        //下載成功
    } else {


    }
});

補充說明

通過返回的 state 來判斷文件是否下載完成,不要通過 percent 來判斷

可用性

iOS系統(tǒng),Android系統(tǒng)

可提供的1.0.0及更高版本

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號