/* * Copyright (c) 2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { AsyncCallback } from './basic'; import { Callback } from './basic'; import BaseContext from './application/BaseContext'; /** * upload and download * @permission ohos.permission.INTERNET */ declare namespace request { /** * Error code 201. the permissions check fails * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_PERMISSION: number; /** * Error code 401. the parameters check fails * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_PARAMCHECK: number; /** * Error code 801. call unsupported api * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_UNSUPPORTED: number; /** * Error code 13400001. file operation error * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_FILEIO: number; /** * Error code 13400002. bad file path * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_FILEPATH: number; /** * Error code 13400003. task manager service error * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_SERVICE: number; /** * Error code 13499999. others error * @syscap SystemCapability.MiscServices.Download * @since 9 */ const EXCEPTION_OTHERS: number; /** * Code 0x00000001. Bit flag indicating download is allowed when using the cellular network. * @syscap SystemCapability.MiscServices.Download * @since 6 * @permission ohos.permission.INTERNET */ const NETWORK_MOBILE: number; /** * Code 0x00010000. Bit flag indicating download is allowed when using the WLAN. * @syscap SystemCapability.MiscServices.Download * @since 6 * @permission ohos.permission.INTERNET */ const NETWORK_WIFI: number; /** * Error code 0. Indicates that the download cannot be resumed for network reasons. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_CANNOT_RESUME: number; /** * Error code 1. Indicates that no storage device, such as an SD card, is found. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_DEVICE_NOT_FOUND: number; /** * Error code 2. Indicates that files to be downloaded already exist, and that the download session cannot overwrite the existing files. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_FILE_ALREADY_EXISTS: number; /** * Error code 3. Indicates that a file operation fails. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_FILE_ERROR: number; /** * Error code 4. Indicates that the HTTP transmission fails. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_HTTP_DATA_ERROR: number; /** * Error code 5. Indicates insufficient storage space. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_INSUFFICIENT_SPACE: number; /** * Error code 6. Indicates an error caused by too many network redirections. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_TOO_MANY_REDIRECTS: number; /** * Error code 7. Indicates an HTTP code that cannot be identified. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_UNHANDLED_HTTP_CODE: number; /** * Error code 8. Indicates an undefined error. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const ERROR_UNKNOWN: number; /** * Error code 9. Indicates network offline. * @syscap SystemCapability.MiscServices.Download * @since 9 * @permission ohos.permission.INTERNET */ const ERROR_OFFLINE: number; /** * Error code 10. Indicates network type configuration error. * @syscap SystemCapability.MiscServices.Download * @since 9 * @permission ohos.permission.INTERNET */ const ERROR_UNSUPPORTED_NETWORK_TYPE: number; /** * Paused code 0. Indicates that the download is paused and waiting for a WLAN connection, because the file size exceeds the maximum allowed for a session using the cellular network. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const PAUSED_QUEUED_FOR_WIFI: number; /** * Paused code 1. Indicates that the download is paused due to a network problem, for example, network disconnection. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const PAUSED_WAITING_FOR_NETWORK: number; /** * Paused code 2. Indicates that a network error occurs, and the download session will be retried. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const PAUSED_WAITING_TO_RETRY: number; /** * Paused code 3. Indicates that the download is paused due to the user. * @syscap SystemCapability.MiscServices.Download * @since 9 * @permission ohos.permission.INTERNET */ const PAUSED_BY_USER: number; /** * Paused code 4. Indicates that the download is paused for some reasons. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const PAUSED_UNKNOWN: number; /** * Session status code 0. Indicates that the download session is completed. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const SESSION_SUCCESSFUL: number; /** * Session status code 1. Indicates that the download session is in progress. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const SESSION_RUNNING: number; /** * Session status code 2. Indicates that the download session is being scheduled. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const SESSION_PENDING: number; /** * Session status code 3. Indicates that the download session has been paused. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const SESSION_PAUSED: number; /** * Session status code 4. Indicates that the download session has failed and will not be retried. * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ const SESSION_FAILED: number; /** * Starts a download task. * @syscap SystemCapability.MiscServices.Download * @since 6 * @deprecated since 9 * @useinstead ohos.request.downloadFile * @param config Download config * @param callback Indicate the callback function to receive DownloadTask. * @permission ohos.permission.INTERNET * @FAModelOnly */ function download(config: DownloadConfig, callback: AsyncCallback): void; /** * Starts a download task. * @syscap SystemCapability.MiscServices.Download * @since 9 * @param BaseContext Indicates the application BaseContext. * @param config Download config * @param callback Indicate the callback function to receive DownloadTask. * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @throws {BusinessError} 13400001 - file operation error * @throws {BusinessError} 13400002 - bad file path * @throws {BusinessError} 13400003 - task service ability error */ function downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallback): void; /** * Starts a download task. * @syscap SystemCapability.MiscServices.Download * @since 6 * @deprecated since 9, * @useinstead ohos.request.downloadFile * @param config Download config * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. * @FAModelOnly */ function download(config: DownloadConfig): Promise; /** * Starts a download task. * @syscap SystemCapability.MiscServices.Download * @since 9 * @param BaseContext Indicates the application BaseContext. * @param config Download config * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @throws {BusinessError} 13400001 - file operation error * @throws {BusinessError} 13400002 - bad file path * @throws {BusinessError} 13400003 - task service ability error */ function downloadFile(context: BaseContext, config: DownloadConfig): Promise; /** * Starts a upload task. * @syscap SystemCapability.MiscServices.Upload * @since 6 * @deprecated since 9 * @useinstead ohos.request.uploadFile * @param config Upload config * @param callback Indicate the callback function to receive UploadTask. * @permission ohos.permission.INTERNET * @FAModelOnly */ function upload(config: UploadConfig, callback: AsyncCallback): void; /** * Starts a upload task. * @syscap SystemCapability.MiscServices.Upload * @since 9 * @param BaseContext Indicates the application BaseContext. * @param config Upload config * @param callback Indicate the callback function to receive UploadTask. * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @throws {BusinessError} 13400002 - bad file path */ function uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback): void; /** * Starts a upload task. * @syscap SystemCapability.MiscServices.Upload * @since 6 * @deprecated since 9 * @useinstead ohos.request.uploadFile * @param config Upload config * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. * @FAModelOnly */ function upload(config: UploadConfig): Promise; /** * Starts a upload task. * @syscap SystemCapability.MiscServices.Upload * @since 9 * @param BaseContext Indicates the application BaseContext. * @param config Upload config * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @throws {BusinessError} 13400002 - bad file path */ function uploadFile(context: BaseContext, config: UploadConfig): Promise; /** * DownloadConfig data Structure * * @name DownloadConfig * @since 6 * @syscap SystemCapability.MiscServices.Download * @permission ohos.permission.INTERNET */ interface DownloadConfig { /** * Resource address. * * @since 6 * @permission ohos.permission.INTERNET */ url: string; /** * Adds an HTTP or HTTPS header to be included with the download request. * * @since 6 * @permission ohos.permission.INTERNET */ header?: Object; /** * Allows download under a metered connection. * * @since 6 * @permission ohos.permission.INTERNET */ enableMetered?: boolean; /** * Allows download in a roaming network. * * @since 6 * @permission ohos.permission.INTERNET */ enableRoaming?: boolean; /** * Sets the description of a download session. * * @since 6 * @permission ohos.permission.INTERNET */ description?: string; /** * Sets the network type allowed for download. * * @since 6 * @permission ohos.permission.INTERNET */ networkType?: number; /** * Sets the path for downloads. * * @since 7 * @permission ohos.permission.INTERNET */ filePath?: string; /** * Sets a download session title. * * @since 6 * @permission ohos.permission.INTERNET */ title?: string; /** * Allow download background task notifications. * * @since 9 */ background?: boolean; } /** * DownloadInfo data Structure * * @name DownloadInfo * @syscap SystemCapability.MiscServices.Download * @since 7 * @permission ohos.permission.INTERNET */ interface DownloadInfo { /** * the description of a file to be downloaded. * * @since 7 * @permission ohos.permission.INTERNET */ description: string; /** * the real-time downloads size (in bytes). * * @since 7 * @permission ohos.permission.INTERNET */ downloadedBytes: number; /** * the ID of a file to be downloaded. * * @since 7 * @permission ohos.permission.INTERNET */ downloadId: number; /** * a download failure cause, which can be any DownloadSession.ERROR_* constant. * * @since 7 * @permission ohos.permission.INTERNET */ failedReason: number; /** * the name of a file to be downloaded. * * @since 7 * @permission ohos.permission.INTERNET */ fileName: string; /** * the URI of a stored file. * * @since 7 * @permission ohos.permission.INTERNET */ filePath: string; /** * the reason why a session is paused, which can be any DownloadSession.PAUSED_* constant. * * @since 7 * @permission ohos.permission.INTERNET */ pausedReason: number; /** * the download status code, which can be any DownloadSession.SESSION_* constant. * * @since 7 * @permission ohos.permission.INTERNET */ status: number; /** * the URI of files to be downloaded. * * @since 7 * @permission ohos.permission.INTERNET */ targetURI: string; /** * the title of a file to be downloaded. * * @since 7 * @permission ohos.permission.INTERNET */ downloadTitle: string; /** * the total size of files to be downloaded (in bytes). * * @since 7 * @permission ohos.permission.INTERNET */ downloadTotalBytes: number; } /** * Download task interface * @permission ohos.permission.INTERNET * @since 6 * @syscap SystemCapability.MiscServices.Download */ interface DownloadTask { /** * Called when the current download session is in process. * @syscap SystemCapability.MiscServices.Download * @since 6 * @param type progress Indicates the download task progress. * @param callback The callback function for the download progress change event * receivedSize the length of downloaded data, in bytes * totalSize he length of data expected to be downloaded, in bytes. * @permission ohos.permission.INTERNET */ on(type: 'progress', callback: (receivedSize: number, totalSize: number) => void): void; /** * Called when the current download session is in process. * @syscap SystemCapability.MiscServices.Download * @since 6 * @param type progress Indicates the download task progress. * @param callback The callback function for the download progress change event * receivedSize the length of downloaded data, in bytes * totalSize he length of data expected to be downloaded, in bytes. * @permission ohos.permission.INTERNET */ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => void): void; /** * Called when the current download session complete pause or remove. * @syscap SystemCapability.MiscServices.Download * @since 7 * @param type Indicates the download session event type * complete: download task completed, * pause: download task stopped, * remove: download task deleted. * @param callback The callback function for the download complete pause or remove change event. * @permission ohos.permission.INTERNET */ on(type: 'complete' | 'pause' | 'remove', callback: () => void): void; /** * Called when the current download session complete pause or remove. * @syscap SystemCapability.MiscServices.Download * @since 7 * @param type Indicates the download session event type * complete: download task completed, * pause: download task stopped, * remove: download task deleted. * @param callback The callback function for the download complete pause or remove change event. * @permission ohos.permission.INTERNET */ off(type: 'complete' | 'pause' | 'remove', callback?: () => void): void; /** * Called when the current download session fails. * @syscap SystemCapability.MiscServices.Download * @since 7 * @param type Indicates the download session type, fail: download task has failed. * @param callback The callback function for the download fail change event * err The error code for download task. * @permission ohos.permission.INTERNET */ on(type: 'fail', callback: (err: number) => void): void; /** * Called when the current download session fails. * @syscap SystemCapability.MiscServices.Download * @since 7 * @param type Indicates the download session type, fail: download task has failed. * @param callback Indicate the callback function to receive err. * err The error code for download task. * @permission ohos.permission.INTERNET */ off(type: 'fail', callback?: (err: number) => void): void; /** * Deletes a download session and the downloaded files. * @syscap SystemCapability.MiscServices.Download * @since 6 * @deprecated since 9 * @useinstead ohos.request.delete * @param callback Indicates asynchronous invoking Result. * @permission ohos.permission.INTERNET */ remove(callback: AsyncCallback): void; /** * Deletes a download session and the downloaded files. * @syscap SystemCapability.MiscServices.Download * @since 6 * @deprecated since 9 * @useinstead ohos.request.delete * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. */ remove(): Promise; /** * Pause a download session. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.suspend * @param callback Indicates asynchronous invoking Result. * @permission ohos.permission.INTERNET */ pause(callback: AsyncCallback): void; /** * Pause a download session. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.suspend * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. */ pause(): Promise; /** * Resume a paused download session. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.restore * @param callback Indicates asynchronous invoking Result. * @permission ohos.permission.INTERNET */ resume(callback: AsyncCallback): void; /** * Resume a paused download session. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.restore * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. */ resume(): Promise; /** * Queries download information of a session, which is defined in DownloadSession.DownloadInfo. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.getTaskInfo * @param callback Indicate the callback function to receive download info. * @permission ohos.permission.INTERNET */ query(callback: AsyncCallback): void; /** * Queries download information of a session, which is defined in DownloadSession.DownloadInfo. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.getTaskInfo * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. */ query(): Promise; /** * Queries the MIME type of the download file. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.getTaskMimeType * @param callback Indicate the callback function to receive download file MIME type. * @permission ohos.permission.INTERNET */ queryMimeType(callback: AsyncCallback): void; /** * Queries the MIME type of the download file. * @syscap SystemCapability.MiscServices.Download * @since 7 * @deprecated since 9 * @useinstead ohos.request.getTaskMimeType * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. */ queryMimeType(): Promise; /** * Delete the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download */ delete(callback: AsyncCallback): void; /** * Delete the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download * @returns { Promise } the promise returned by the function. */ delete(): Promise; /** * Suspend the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download */ suspend(callback: AsyncCallback): void; /** * Suspend the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download * @returns { Promise } the promise returned by the function. */ suspend(): Promise; /** * Restore the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download */ restore(callback: AsyncCallback): void; /** * Restore the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download * @returns { Promise } the promise returned by the function. */ restore(): Promise; /** * Get the download task info * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download */ getTaskInfo(callback: AsyncCallback): void; /** * Get the download task info * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download * @returns { Promise } the promise returned by the function. */ getTaskInfo(): Promise; /** * Get mimetype of the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download */ getTaskMimeType(callback: AsyncCallback): void; /** * Get mimetype of the download task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Download * @returns { Promise } the promise returned by the function. */ getTaskMimeType(): Promise; } /** * File data Structure * * @name File * @since 6 * @syscap SystemCapability.MiscServices.Download * @permission ohos.permission.INTERNET */ interface File { /** * When multipart is submitted, the file name in the request header. * * @since 6 * @permission ohos.permission.INTERNET */ filename: string; /** * When multipart is submitted, the name of the form item. The default is file. * * @since 6 * @permission ohos.permission.INTERNET */ name: string; /** * The local storage path of the file (please refer to the storage directory definition for path usage). * * @since 6 * @permission ohos.permission.INTERNET */ uri: string; /** * The content type of the file is obtained by default according to the suffix of the file name or path. * * @since 6 * @permission ohos.permission.INTERNET */ type: string; } /** * RequestData data Structure * * @name RequestData * @since 6 * @syscap SystemCapability.MiscServices.Download * @permission ohos.permission.INTERNET */ interface RequestData { /** * Represents the name of the form element. * * @since 6 * @permission ohos.permission.INTERNET */ name: string; /** * Represents the value of the form element. * * @since 6 * @permission ohos.permission.INTERNET */ value: string; } /** * UploadConfig data Structure * * @name UploadConfig * @since 6 * @syscap SystemCapability.MiscServices.Upload * @permission ohos.permission.INTERNET */ interface UploadConfig { /** * Resource address. * * @since 6 * @permission ohos.permission.INTERNET */ url: string; /** * Adds an HTTP or HTTPS header to be included with the upload request. * * @since 6 * @permission ohos.permission.INTERNET */ header: Object; /** * Request method: POST, PUT. The default POST. * * @since 6 * @permission ohos.permission.INTERNET */ method: string; /** * A list of files to be uploaded. Please use multipart/form-data to submit. * * @since 6 * @permission ohos.permission.INTERNET */ files: Array; /** * The requested form data. * * @since 6 * @permission ohos.permission.INTERNET */ data: Array; } /** * TaskState data Structure * * @name TaskState * @since 9 * @syscap SystemCapability.MiscServices.Upload * @permission ohos.permission.INTERNET */ interface TaskState { /** * Upload file path. * * @since 9 * @permission ohos.permission.INTERNET */ path: string; /** * Upload task return value. * * @since 9 * @permission ohos.permission.INTERNET */ responseCode: number; /** * Upload task information. * * @since 9 * @permission ohos.permission.INTERNET */ message: string; } /** * Upload task interface * @permission ohos.permission.INTERNET * @since 6 * @syscap SystemCapability.MiscServices.Download */ interface UploadTask { /** * Called when the current upload session is in process. * @syscap SystemCapability.MiscServices.Upload * @since 6 * @param type progress Indicates the upload task progress. * @param callback The callback function for the upload progress change event * uploadedSize The length of uploaded data, in bytes * totalSize The length of data expected to be uploaded, in bytes. * @permission ohos.permission.INTERNET */ on(type: 'progress', callback: (uploadedSize: number, totalSize: number) => void): void; /** * Called when the current upload session is in process. * @syscap SystemCapability.MiscServices.Upload * @since 6 * @param type progress Indicates the upload task progress. * @param callback The callback function for the upload progress change event * uploadedSize The length of uploaded data, in bytes * totalSize The length of data expected to be uploaded, in bytes. * @permission ohos.permission.INTERNET */ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) => void): void; /** * Called when the header of the current upload session has been received. * @syscap SystemCapability.MiscServices.Upload * @since 7 * @param type headerReceive Indicates the upload task headed receive. * @param callback The callback function for the HTTP Response Header event * header HTTP Response Header returned by the developer server. * @permission ohos.permission.INTERNET */ on(type: 'headerReceive', callback: (header: object) => void): void; /** * Called when the header of the current upload session has been received. * @syscap SystemCapability.MiscServices.Upload * @since 7 * @param type headerReceive Indicates the upload task headed receive. * @param callback The callback function for the HTTP Response Header event * header HTTP Response Header returned by the developer server. * @permission ohos.permission.INTERNET */ off(type: 'headerReceive', callback?: (header: object) => void): void; /** * Called when the current upload session complete or fail. * @syscap SystemCapability.MiscServices.Upload * @since 9 * @param type Indicates the upload session event type * complete: upload task completed * fail: upload task failed * @param callback The callback function for the upload complete or fail change event. * @permission ohos.permission.INTERNET */ on(type:'complete' | 'fail', callback: Callback>): void; /** * Called when the current upload session complete or fail. * @syscap SystemCapability.MiscServices.Upload * @since 9 * @param type Indicates the upload session event type * complete: upload task completed * fail: upload task failed * @permission ohos.permission.INTERNET */ off(type:'complete' | 'fail', callback?: Callback>): void; /** * Deletes a upload session. * @syscap SystemCapability.MiscServices.Upload * @since 6 * @deprecated since 9 * @useinstead ohos.request.delete * @param callback Indicates asynchronous invoking Result. * @permission ohos.permission.INTERNET */ remove(callback: AsyncCallback): void; /** * Deletes a upload session. * @syscap SystemCapability.MiscServices.Upload * @since 6 * @deprecated since 9 * @useinstead ohos.request.delete * @permission ohos.permission.INTERNET * @returns { Promise } the promise returned by the function. */ remove(): Promise; /** * Delete the upload task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Upload */ delete(callback: AsyncCallback): void; /** * Delete the upload task * @since 9 * @permission ohos.permission.INTERNET * @throws {BusinessError} 201 - the permissions check fails * @throws {BusinessError} 401 - the parameters check fails * @syscap SystemCapability.MiscServices.Upload * @returns { Promise } the promise returned by the function. */ delete(): Promise; } } export default request;