字節(jié)跳動(dòng)小程序開發(fā)API uploadFile

2019-08-13 10:17 更新

將本地文件上傳到網(wǎng)絡(luò)。

提示

網(wǎng)絡(luò)相關(guān)的 API 在使用前需要配置域名白名單。請參考網(wǎng)絡(luò)請求使用說明

提示

HTTP 請求 method 為POST

輸入


繼承標(biāo)準(zhǔn)對象輸入,擴(kuò)展屬性描述:

名稱 數(shù)據(jù)類型 屬性 默認(rèn)值 描述
url string required N/A 目標(biāo)地址
filePath string required N/A 本地文件路徑
name string required N/A HTTP 請求的文件名
header object optional {'content-type': 'multipart/form-data'} 請求Header
formData object optional null 請求額外參數(shù)

輸出


success返回對象參數(shù)的擴(kuò)展屬性:

名稱 數(shù)據(jù)類型 描述
data string 返回?cái)?shù)據(jù)
statusCode number 返回 HTTP 狀態(tài)碼

本 API 的調(diào)用結(jié)果在通過回調(diào)傳遞的同時(shí)會(huì)返回一個(gè)uploadTask對象,可以通過該對象的abort方法中斷請求任務(wù);通過onProgressUpdate方法監(jiān)聽下載進(jìn)度。

onProgressUpdate注冊的監(jiān)聽方法會(huì)收到一個(gè)object類型參數(shù),該參數(shù)的屬性值有:

名稱 數(shù)據(jù)類型 描述
progress number 上傳進(jìn)度
totalBytesSent number 已經(jīng)上傳的數(shù)據(jù)長度,單位byte
totalBytesExpectedToSend number 預(yù)期需要上傳的數(shù)據(jù)總長度,單位byte

代碼示例


let task = tt.uploadFile({
    url: 'someuploadurl',
    filePath: tempFilePath,
    name: 'file',
    success (res) {
        if (res.statusCode === 200) {
            console.log(`uploadFile調(diào)用成功 ${res.data}`);
        }
    },
    fail (res) {
        console.log(`uploadFile調(diào)用失敗`);
    }
});

task.onProgressUpdate((res) => {
    this.setData({
        progress: res.progress
    });
});

if (someReason) {
    task.abort();
}

已知問題



以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)