@system.request (Upload and Download)

The system.request module provides applications with basic upload and download capabilities.

The APIs of this module are deprecated since API version 9. You are advised to use @ohos.request instead.
The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { Request } from '@kit.BasicServicesKit';

request.upload^(deprecated)

upload(options: UploadRequestOptions): void

Uploads a file. This API returns no value.

System capability: SystemCapability.MiscServices.Upload

This API has been supported since API version 3 and deprecated since API version 9. You are advised to use request.uploadFile instead.

Parameters

Name	Type	Mandatory	Description
options	UploadRequestOptions	Yes	Upload configurations.

Example

import  { Request, UploadRequestOptions, UploadResponse } from '@kit.BasicServicesKit';

let uploadRequestOptions: 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: (data: UploadResponse) => {
    console.info('Succeeded in uploading, code:' + JSON.stringify(data.code));
  },
  fail: (data: string, code: number) => {
    console.info('Failed to upload, data: ' + data + 'code: ' + code);
  },
  complete: () => {
    console.info('Upload complete');
  }
}

try {
  Request.upload(uploadRequestOptions);
  console.info('Start Upload');
} catch (err) {
  console.error('Failed to upload, err:' + err);
}

UploadRequestOptions^(deprecated)

System capability: SystemCapability.MiscServices.Upload

This API has been supported since API version 3 and deprecated since API version 9. You are advised to use UploadConfig instead.

Name	Type	Read-Only	Optional	Description
url	string	No	No	URL of the upload server.
data	Array<RequestData>	No	Yes	Form data in the request body.
files	Array<RequestFile>	No	No	List of files to upload, which is submitted through multipart/form-data.
header	Object	No	Yes	Request header.
method	string	No	Yes	Request method, which can be 'POST' or 'PUT'. The default value is POST.
success	(data: UploadResponse) => void	No	Yes	Called when API call is successful.
fail	(data: any, code: number) => void	No	Yes	Called when API call has failed. Response headers and the HTTP status code are returned.
complete	() => void	No	Yes	Called when API call is complete.

UploadResponse^(deprecated)

System capability: SystemCapability.MiscServices.Upload

Name	Type	Read-Only	Optional	Description
code	number	No	No	HTTP status code returned by the server.
data	string	No	No	Content returned by the server. The value type is determined by the type in the response header.
headers	Object	No	No	Response headers returned by the server.

RequestFile^(deprecated)

System capability: SystemCapability.MiscServices.Upload

Name	Type	Read-Only	Optional	Description
filename	string	No	Yes	File name in the header when multipart is used.
name	string	No	Yes	Name of a form item when multipart is used. The default value is file.
uri	string	No	No	Local path for storing files.
type	string	No	Yes	Type of the file content. By default, the type is obtained based on the extension of the file name or URI.

RequestData^(deprecated)

System capability: SystemCapability.MiscServices.Upload

Name	Type	Read-Only	Optional	Description
name	string	No	No	Name of the form element.
value	string	No	No	Value of the form element.