HarmonyOS API：@system.request (上传下载)

joytrian

发布于 2023-4-12 18:13

浏览

0收藏

版本：v3.1 Beta

@system.request (上传下载)

更新时间: 2023-02-17 09:19

system.request部件主要给应用提供上传下载文件的基础能力。

说明

从API Version 9开始所有接口不再维护，推荐使用新接口@ohos.request。
本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import request from '@system.request';

request.upload

upload(options: UploadRequestOptions): void

上传文件，无返回值。

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload

参数：

参数名	类型	必填	说明
options	UploadRequestOptions	是	上传的配置信息。

示例：

let uploadRequestOptions = {
  url: 'http://www.path.com',
  method: 'POST',
  files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }],
  data: [{ name: "name123", value: "123" }],
  success: function(data) {
    console.info(' upload success, code:' + JSON.stringify(data));
  },
  fail: function(data, code) {
    console.info(' upload fail data: ' + data + 'code: ' + code);
  },
  complete: function (){
    console.info(' upload complete');
  }
}
try {
  request.upload(uploadRequestOptions);
  console.info('upload start ');
} catch(err) {
  console.info(' upload err:' + err);
}

UploadRequestOptions

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。

名称	类型	必填	说明
url	string	是	上传服务器地址。
data	Array<RequestData>	否	请求的表单数据。
files	Array<RequestFile>	是	待上传文件列表。请使用multipart/form-data进行提交。
header	Object	否	请求头。
method	string	否	请求方法：POST、PUT。缺省POST。
success	Function	否	接口调用成功的回调函数。
fail	Function	否	接口调用失败的回调函数。
complete	Function	否	接口调用结束的回调函数。

success参数：

参数名	类型	必填	说明
data	UploadResponse	是	上传任务成功返回信息。

fail参数：

参数名	类型	必填	说明
data	any	是	上传任务失败返回header信息。
code	number	是	上传任务失败返回HTTP状态码。

UploadResponse

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。

名称	类型	必填	说明
code	number	是	服务器返回的HTTP状态码。
data	string	是	服务器返回的内容。根据返回头内容中的type决定该值的类型。
headers	Object	是	服务器返回的返回头内容。

RequestFile

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。

名称	类型	必填	说明
filename	string	否	multipart 提交时，请求头中的文件名。
name	string	否	multipart 提交时，表单项目的名称，缺省为file。
uri	string	是	文件的本地存储路径。
type	string	否	文件的内容类型，默认根据文件名或路径的后缀获取。

RequestData

系统能力: SystemCapability.MiscServices.Upload。

名称	类型	必填	说明
name	string	是	表示form 元素的名称。
value	string	是	表示form 元素的值。

request.download

download(options: DownloadRequestOptions): void

下载文件，无返回值。

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
options	DownloadRequestOptions	是	下载的配置信息。

示例：

let downloadRequestOptions = {
  url: 'http://www.path.com',
  filename: 'requestSystenTest',
  header: '',
  description: 'this is requeSystem download response',
  success: function(data) {
    console.info(' download success, code:' + JSON.stringify(data));
  },
  fail: function(data, code) {
    console.info(' download fail data: ' + data + 'code: ' + code);
  },
  complete: function (){
    console.info(' download complete');
  }
}
try {
  request.download(downloadRequestOptions);
  console.info('download start ');
} catch(err) {
  console.info(' download err:' + err);
}

DownloadRequestOptions

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download。

名称	类型	必填	说明
url	string	是	资源地址。
filename	string	否	本次下载文件的名称。默认从本次请求或资源地址中获取。
header	Object	否	请求头。
description	string	否	资源地址的下载描述，默认为文件名称。
success	Function	否	接口调用成功的回调函数。
fail	Function	否	接口调用失败的回调函数。
complete	Function	否	接口调用结束的回调函数。

success参数：

参数名	类型	必填	说明
data	DownloadResponse	是	下载任务成功返回信息。

fail参数：

参数名	类型	必填	说明
data	any	是	下载任务失败返回header信息。
code	number	是	下载任务失败返回HTTP状态码。

DownloadResponse

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download。

参数名	类型	必填	说明
token	string	是	表示下载的token，获取下载状态的依据。

request.onDownloadComplete

onDownloadComplete(options: OnDownloadCompleteOptions): void

获取下载任务状态，无返回值。

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
options	OnDownloadCompleteOptions	是	监听下载任务的配置信息。

示例：

let onDownloadCompleteOptions = {
  token: 'token-index',
  success: function(data) {
    console.info(' download success, code:' + JSON.stringify(data));
  },
  fail: function(data, code) {
    console.info(' download fail data: ' + data + 'code: ' + code);
  },
  complete: function (){
    console.info(' download complete');
  }
}
request.onDownloadComplete(onDownloadCompleteOptions);

OnDownloadCompleteOptions

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download。

名称	类型	必填	说明
token	string	是	download 接口返回的结果 token。
success	Function	否	接口调用成功的回调函数。
fail	Function	否	接口调用失败的回调函数。
complete	Function	否	接口调用结束的回调函数。

success参数：

参数名	类型	必填	说明
data	OnDownloadCompleteResponse	是	下载任务成功返回信息。

fail参数：

参数名	类型	必填	说明
data	any	是	下载任务失败返回header信息。
code	number	是	下载任务失败返回HTTP状态码。

OnDownloadCompleteResponse

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download。

名称	类型	说明
uri	string	表示下载文件的uri。

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-system-request-0000001478181721-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478181721__导入模块

分类

卡片开发

三方库

标签

HarmonyOS API

已于2023-4-12 18:13:47修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@system.request (上传下载)

@system.request (上传下载)

导入模块

request.upload

UploadRequestOptions

UploadResponse

RequestFile

RequestData

request.download

DownloadRequestOptions

DownloadResponse

request.onDownloadComplete

OnDownloadCompleteOptions

OnDownloadCompleteResponse

目录

订阅鸿蒙技术特刊，精选内容抢先看