下载

接口定义

qg.downloadFile(Object object)

• 描述

  下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，通过回调函数返回文件的本地临时路径。返回一个DownloadTask对象。

  说明

  不指定下载路径，使用临时路径可下载超过50M的文件至本地。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  url	string	M	下载资源的url。
  header	object	O	HTTP请求的Header，Header中不能设置Referer。
  filePath	string	O	指定文件下载后存储的路径+文件名。 如果没有设置filePath：调用完成后生成一个临时路径，临时路径可以在success回调中通过res.tempFilePath获取。success(res) { let filePath = res.tempFilePath;} 如果设置filePath：返回路径为设置的路径，且目录必须是`${qg.env.USER_DATA_PATH}/`手机上的用户个人目录，如qg.env.USER_DATA_PATH+ "/sdcard/Pictures/Screenshots/test.zip"，如果设置的路径已存在，下载的内容将覆盖原路径的内容。
  success	function	O	接口调用成功的回调函数。
  fail	function	O	接口调用失败的回调函数。
  complete	function	O	若有函数传入，将在成功、失败后调用该函数。

  • success回调函数参数
    展开

    参数	类型	说明
    tempFilePath	string	临时文件路径 (本地路径)。没传入filePath指定文件存储路径时会返回，下载后的文件会存储到一个临时文件。
    filePath	string	用户文件路径 (本地路径)。传入filePath时会返回，跟传入的filePath一致。
    statusCode	number	开发者服务器返回的HTTP状态码。

• 示例代码

  qg.downloadFile({
      url: "http://127.0.0.1:8080/docs/test.zip",
      filePath:qg.env.USER_DATA_PATH +"/sdcard/Pictures/Screenshots/test.zip",
      success() {
          console.log("success");
      },
      fail(e) {
          console.error(e.errMsg);
      },
      complete() {
          console.log("complete");
      }
  });

DownloadTask.abort()

• 描述

  中断下载任务。

DownloadTask.onProgressUpdate(function callback)

• 描述

  监听下载进度变化事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	下载进度变化事件的回调函数。

  • callback回调函数参数
    展开

    参数	类型	说明
    progress	number	下载进度百分比。
    totalBytesWritten	number	已经下载的数据长度，单位Bytes。
    totalBytesExpectedToWrite	number	预期需要下载的数据总长度，单位Bytes。

• 示例代码

  var downloadTask = qg.downloadFile({
          url : 'url'
  });
  downloadTask.onProgressUpdate(
          callback(res){console.log("onProgressUpdate result = " + JSON.stringify(res));}
  )

相关链接

案例

使用qg.downloadFile下载和解压远程压缩文件失败