百度智能小程序API 網(wǎng)絡(luò)

請求

request

解釋：發(fā)起網(wǎng)絡(luò)請求

方法參數(shù)：Object

Object參數(shù)說明：

success 返回參數(shù)說明：

data 數(shù)據(jù)說明：

最終發(fā)送給服務(wù)器的數(shù)據(jù)是 String 類型，如果傳入的 data 不是 String 類型，會被轉(zhuǎn)換成 String 。轉(zhuǎn)換規(guī)則如下：

1、對于 header[‘content-type’] 為 application/json 的數(shù)據(jù)，會對數(shù)據(jù)進(jìn)行 JSON 序列化。

2、對于 header[‘content-type’] 為 application/x-www-form-urlencoded 的數(shù)據(jù)，會將數(shù)據(jù)轉(zhuǎn)換成 query string （encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)…）。

示例：

swan.request({
    url: '/example/abc', //開發(fā)者服務(wù)器接口地址
    method: 'GET',
    dataType: 'json',
    data: {
        key1: 'value1' ,
        key2: {}
    },
    header: {
        'content-type': 'application/json' // 默認(rèn)值
    },
    success: function (res) {
        console.log(res.data);
    },
    fail: function (err) {
        console.log("錯誤碼：" + err.errCode);
        console.log("錯誤信息：" + err.errMsg);
    }
});

上傳、下載

uploadFile

解釋：將本地資源上傳到開發(fā)者服務(wù)器，客戶端發(fā)起一個 HTTPS POST 請求，其中 content-type 為 multipart/form-data

方法參數(shù)：Object

Object參數(shù)說明：

success返回參數(shù)說明：

示例：

swan.chooseImage({
    success: function (res) {
        swan.uploadFile({
            url: 'https://smartapp.baidu.com/xxx', // 開發(fā)者服務(wù)器 url
            filePath: res.tempFilePaths[0], // 要上傳文件資源的路徑
            name: 'myfile',
            success: function (res) {
                console.log(res.statusCode);
            },
            fail: function (err) {
                console.log("錯誤碼：" + err.errCode);
                console.log("錯誤信息：" + err.errMsg);
            }
        });
    }
});

uploadTask 對象的方法列表：

onProgressUpdate 返回參數(shù)說明：

示例：

const uploadTask = swan.uploadFile({
    url: 'https://example.baidu.com/xxxx', //開發(fā)者服務(wù)器 url
    filePath: res.tempFilePaths[0], // 要上傳文件資源的路徑
    name: 'myfile',
    success: function (res){
        console.log(res.statusCode);
    },
    fail: function (err) {
        console.log("錯誤碼：" + err.errCode);
        console.log("錯誤信息：" + err.errMsg);
    }
});

uploadTask.onProgressUpdate(res => {
    console.log('上傳進(jìn)度', res.progress)
    console.log('已經(jīng)上傳的數(shù)據(jù)長度', res.totalBytesSent)
    console.log('預(yù)期需要上傳的數(shù)據(jù)總長度', res.totalBytesExpectedToSend)
});

uploadTask.abort(); // 取消上傳任務(wù)

downloadFile

解釋： 下載文件資源到本地，客戶端直接發(fā)起一個 HTTP GET 請求，返回文件的本地臨時路徑

方法參數(shù)： Object

Object參數(shù)說明：

注意： 文件的臨時路徑，在智能小程序本次啟動期間可以正常使用，如需持久保存，需在主動調(diào)用 swan.saveFile，才能在智能小程序下次啟動時訪問得到。

success返回參數(shù)說明：

示例：

swan.downloadFile({
    url: 'https://example.baidu.com/xxxx', //僅為示例，并非真實的資源
    success: function (res) {
        //下載成功
        if (res.statusCode === 200) {
            console.log("臨時文件路徑" + res.tempFilePath);
        }
    },
    fail: function (err) {
        console.log("錯誤碼：" + err.errCode);
        console.log("錯誤信息：" + err.errMsg);
    }
});

downloadTask 對象的方法列表：

onProgressUpdate 返回參數(shù)說明：

示例：

const downloadTask = swan.downloadFile({
    url: 'https://example.baidu.com/xxxx', //開發(fā)者服務(wù)器 url
    success: function (res){
        console.log(res.tempFilePath);
    },
    fail: function (err) {
        console.log("錯誤碼：" + err.errCode);
        console.log("錯誤信息：" + err.errMsg);
    }
});

downloadTask.onProgressUpdate(res => {
    console.log('下載進(jìn)度', res.progress);
    console.log('已經(jīng)下載的數(shù)據(jù)長度', res.totalBytesWritten);
    console.log('預(yù)期需要下載的數(shù)據(jù)總長度', res.totalBytesExpectedToWrite);
});

downloadTask.abort(); // 取消下載任務(wù)

1、tip: uploadFile 上傳文件大小限制為 25M。

WebSocket

connectSocket

解釋： 創(chuàng)建一個 WebSocket 連接。

參數(shù)： Object

一個智能小程序同時只能有一個 WebSocket 連接，如果當(dāng)前已存在一個 WebSocket 連接，會替換成最新創(chuàng)建的WebSocket連接。

Object參數(shù)說明：

示例：

swan.connectSocket({
	url: 'wss://example.baidu.com'
});

onSocketOpen

解釋： 監(jiān)聽 WebSocket 連接打開事件。

參數(shù)： CALLBACK

示例：

swan.onSocketOpen(function () {
    console.log('WebSocket連接已打開！');
}
});

onSocketError

解釋： 監(jiān)聽 WebSocket 錯誤

參數(shù)： CALLBACK

示例： 

swan.connectSocket({
    url: 'wss://example.baidu.com'
});
swan.onSocketOpen(function (res) {
    console.log('WebSocket連接已打開！');
});
swan.onSocketError(function (res) {
    console.log('WebSocket連接打開失敗，請檢查！');
});

sendSocketMessage

解釋： 通過 WebSocket 連接發(fā)送數(shù)據(jù)，需要先 connectSocket，并在 onSocketOpen 回調(diào)之后才能發(fā)送。

參數(shù)： Object

Object參數(shù)說明：

示例：

swan.sendSocketMessage({
    data: 'this is swan',
    complete: function () {
        console.log(new Date().getTime() + '    :i am complete');
    }
});

onSocketMessage

解釋： 監(jiān)聽 WebSocket 接受到服務(wù)器的消息事件

參數(shù)： CALLBACK

示例：

swan.connectSocket({
    url: 'wss://example.baidu.com'
});
swan.onSocketMessage(function (res) {
    console.log('收到服務(wù)器內(nèi)容：' + res.data);
});

closeSocket

解釋： 關(guān)閉 WebSocket 連接。

參數(shù)： Object

Object參數(shù)說明：

示例：

swan.closeSocket({
    code: 1001,
    reason: '網(wǎng)線被切了',
    success: function () {
        console.log('WebSocket 關(guān)閉');
    }
});

onSocketClose

解釋： 監(jiān)聽 WebSocket 關(guān)閉。

參數(shù)： CALLBACK

示例：

swan.onSocketClose(function () {
    console.log('WebSocket 已關(guān)閉');
});

SocketTask

解釋： WebSocket 任務(wù)，可通過 swan.connectSocket() 接口創(chuàng)建返回。

SocketTask 方法

1、send(對應(yīng) swan.sendSocketMessage)

2、close(對應(yīng) swan.closeSocket)

3、onOpen(對應(yīng) swan.onSocketOpen)

4、onClose(對應(yīng) swan.onSocketClose)

5、onError(對應(yīng) swan.onSocketError)

6、onMessage(對應(yīng) swan.onSocketMessage)