上傳下載

說明： 本模塊首批接口從API version 6開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import request from '@ohos.request';

限制與約束

默認支持https，如果要支持http，需要在config.json里增加network標簽，屬性標識 "cleartextTraffic": true。即：

"deviceConfig": {
    "default": {
      "network": {
        "cleartextTraffic": true
      }
      ...
    }
  }

常量

需要權限 ：ohos.permission.INTERNET

系統能力 : 以下各項對應的系統能力均為SystemCapability.MiscServices.Download。

request.upload

upload(config: UploadConfig): Promise

上傳，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

返回值：

示例：

let file1 = { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" };
let data = { name: "name123", value: "123" };
let header = { key1: "value1", key2: "value2" };
let uploadTask;
request.upload({ url: 'https://patch', header: header, method: "POST", files: [file1], data: [data] }).then((data) = > {
    uploadTask = data;
}).catch((err) = > {
    console.error('Failed to request the upload. Cause: ' + JSON.stringify(err));
})

request.upload

upload(config: UploadConfig, callback: AsyncCallback): void

上傳，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

示例：

let file1 = { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" };
let data = { name: "name123", value: "123" };
let header = { key1: "value1", key2: "value2" };
let uploadTask;
request.upload({ url: 'https://patch', header: header, method: "POST", files: [file1], data: [data] }, (err, data) = > {
    if (err) {
        console.error('Failed to request the upload. Cause: ' + JSON.stringify(err));
        return;
    }
    uploadTask = data;
});

UploadTask

上傳任務，使用下列方法前，需要先獲取UploadTask對象。

on('progress')

on(type: 'progress', callback:(uploadedSize: number, totalSize: number) => void): void

開啟上傳任務監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

回調函數的參數

示例：

uploadTask.on('progress', function callback(uploadedSize, totalSize) {
    console.info("upload totalSize:" + totalSize + "  uploadedSize:" + uploadedSize);
}
);

on('headerReceive')7+

on(type: 'headerReceive', callback: (header: object) => void): void

開啟上傳任務監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

回調函數的參數：

示例：

uploadTask.on('headerReceive', function callback(headers){   
    console.info("upOnHeader headers:" + JSON.stringify(headers));
}
);

off('progress')

off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) => void): void

關閉上傳任務監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

回調函數的參數：

示例：

uploadTask.off('progress', function callback(uploadedSize, totalSize) {
    console.info('uploadedSize: ' + uploadedSize, 'totalSize: ' + totalSize);
}
);

off('headerReceive')7+

off(type: 'headerReceive', callback?: (header: object) => void): void

關閉上傳任務監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

回調函數的參數：

示例：

uploadTask.off('headerReceive', function callback(headers) {
    console.info("upOnHeader headers:" + JSON.stringify(headers));
}
);

remove

remove(): Promise

移除上傳的任務，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

返回值：

示例：

uploadTask.remove().then((result) = > {
    if (result) {
        console.info('Upload task removed successfully. ');
    } else {
        console.error('Failed to remove the upload task. ');
    }
}).catch((err) = > {
    console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err));
});

remove

remove(callback: AsyncCallback): void

移除上傳的任務，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Upload

參數：

示例：

uploadTask.remove((err, result) = > {
    if (err) {
        console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Upload task removed successfully.');
    } else {
        console.error('Failed to remove the upload task.');
    }
});

UploadConfig

系統能力 : 以下各項對應的系統能力均為SystemCapability.MiscServices.Upload。

File

系統能力 : 以下各項對應的系統能力均為SystemCapability.MiscServices.Upload。

RequestData

系統能力 : 以下各項對應的系統能力均為SystemCapability.MiscServices.Upload。

request.download

download(config: DownloadConfig): Promise

下載，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

返回值：

示例：

let downloadTask;
request.download({ url: 'https://xxxx/xxxx.hap' }).then((data) = > {
    downloadTask = data;
}).catch((err) = > {
    console.error('Failed to request the download. Cause: ' + JSON.stringify(err));
})

request.download

download(config: DownloadConfig, callback: AsyncCallback): void

下載，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

let downloadTask;
request.download({ url: 'https://xxxx/xxxxx.hap', 
filePath: 'xxx/xxxxx.hap'}, (err, data) = > {
    if (err) {
        console.error('Failed to request the download. Cause: ' + JSON.stringify(err));
        return;
    }
    downloadTask = data;
});

DownloadTask

下載任務。

on('progress')

on(type: 'progress', callback:(receivedSize: number, totalSize: number) => void): void

開啟下載任務監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

回調函數的參數：

示例：

downloadTask.on('progress', function download_callback(receivedSize, totalSize) {
    console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}
);
});

off('progress')

off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => void): void

關閉下載任務監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

回調函數的參數：

示例：

downloadTask .off('progress', function download_callback(receivedSize, totalSize) {
        console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
    }
);
});

on('complete'|'pause'|'remove')7+

on(type: 'complete'|'pause'|'remove', callback:() => void): void

開啟下載任務相關的監聽，異步方法，使用callback形式返回。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.on('complete', function callback() {
        console.info('Download task completed.');
    }
);
});

off('complete'|'pause'|'remove')7+

off(type: 'complete'|'pause'|'remove', callback?:() => void): void

取消下載任務相關的監聽，異步方法，使用callback形式返回。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.off('complete', function callback() {
        console.info('Download task completed.');
    }
);
});

on('fail')7+

on(type: 'fail', callback: (err: number) => void): void

開啟下載任務失敗監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

回調函數的參數：

示例：

downloadTask.on('fail', function callBack(err) {
        console.info('Download task failed. Cause:' + err);
    }
);
});

off('fail')7+

off(type: 'fail', callback?: (err: number) => void): void

取消下載任務失敗監聽，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

回調函數的參數

示例：

downloadTask.off('fail', function callBack(err) {
        console.info('Download task failed. Cause:' + err);
    } 
);
});

remove

remove(): Promise

移除下載的任務，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

返回值：

示例：

downloadTask.remove().then((result) = > {
    if (result) {
        console.info('Download task removed.');
    } else {
        console.error('Failed to remove the download task.');
    }
}).catch ((err) = > {
    console.error('Failed to remove the download task.');
});

remove

remove(callback: AsyncCallback): void

移除下載的任務，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.remove((err, result)= >{
    if(err) {
        console.error('Failed to remove the download task.');
        return;
    } 
    if (result) {
        console.info('Download task removed.');
    } else {
        console.error('Failed to remove the download task.');
    } 
});

query7+

query(): Promise

查詢下載任務，異步方法，使用promise形式返回DownloadInfo里的信息。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.query().then((downloadInfo) = > {    
    console.info('Download task queried. Data:' + JSON.stringify(downloadInfo))
}) .catch((err) = > {
    console.error('Failed to query the download task. Cause:' + err)
});

query7+

query(callback: AsyncCallback): void

查詢下載的任務，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.query((err, downloadInfo)= >{
    if(err) {
        console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err));
    } else {
        console.info('download query success. data:'+ JSON.stringify(downloadInfo));
    }
});

queryMimeType7+

queryMimeType(): Promise

查詢下載的任務的 MimeType，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

返回值：

示例：

downloadTask.queryMimeType().then((data) = > {    
    console.info('Download task queried. Data:' + JSON.stringify(data));
}).catch((err) = > {
    console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err))
});

queryMimeType7+

queryMimeType(callback: AsyncCallback): void;

查詢下載的任務的 MimeType，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.queryMimeType((err, data)= >{
    if(err) {
        console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err));
    } else {
        console.info('Download task queried. data:' + JSON.stringify(data));
    }
});

pause7+

pause(): Promise

暫停下載任務，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

返回值：

示例：

downloadTask.pause().then((result) = > {    
    if (result) {
         console.info('Download task paused. ');
    } else {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(result));
    }
}).catch((err) = > {
    console.error('Failed to pause the download task. Cause:' + JSON.stringify(err));
});

pause7+

pause(callback: AsyncCallback): void

暫停下載任務，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.pause((err, result)= >{
    if(err) {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(err));
        return;
    }
    if (result) {
         console.info('Download task paused. ');
    } else {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(result));
    }
});

resume7+

resume(): Promise

重新啟動暫停的下載任務，異步方法，使用promise形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.resume().then((result) = > {
    if (result) {
        console.info('Download task resumed.')
    } else {
        console.error('Failed to resume the download task. ');
    }
    console.info('Download task resumed.')
}).catch((err) = > {
    console.error('Failed to resume the download task. Cause:' + err);
});

resume7+

resume(callback: AsyncCallback): void

重新啟動暫停的下載任務，異步方法，使用callback形式返回結果。

需要權限 ：ohos.permission.INTERNET

系統能力 : SystemCapability.MiscServices.Download

參數：

示例：

downloadTask.resume((err, result)= >{
    if (err) {
        console.error('Failed to resume the download task. Cause:' + err);
        return;
    } 
    if (result) {
        console.info('Download task resumed.');
    } else {
        console.error('Failed to resume the download task.');
    }
});

DownloadConfig

系統能力 : SystemCapability.MiscServices.Download

DownloadInfo7+

系統能力 : SystemCapability.MiscServices.Download

審核編輯 黃宇