新聞中心
API
小程序開發(fā)框架提供豐富的微信原生 API,可以方便的調(diào)起微信提供的能力,如獲取用戶信息,本地存儲,支付功能等。詳細介紹請參考 API 文檔。

為神池等地區(qū)用戶提供了全套網(wǎng)頁設(shè)計制作服務(wù),及神池網(wǎng)站建設(shè)行業(yè)解決方案。主營業(yè)務(wù)為做網(wǎng)站、成都網(wǎng)站制作、神池網(wǎng)站設(shè)計,以傳統(tǒng)方式定制建設(shè)網(wǎng)站,并提供域名空間備案等一條龍服務(wù),秉承以專業(yè)、用心的態(tài)度為用戶提供真誠的服務(wù)。我們深信只要達到每一位用戶的要求,就會得到認可,從而選擇與我們長期合作。這樣,我們也可以走得更遠!
通常,在小程序 API 有以下幾種類型:
事件監(jiān)聽 API
我們約定,以 on 開頭的 API 用來監(jiān)聽某個事件是否觸發(fā),如:wx.onSocketOpen,wx.onCompassChange 等。
這類 API 接受一個回調(diào)函數(shù)作為參數(shù),當事件觸發(fā)時會調(diào)用這個回調(diào)函數(shù),并將相關(guān)數(shù)據(jù)以參數(shù)形式傳入。
代碼示例
wx.onCompassChange(function (res) {
console.log(res.direction)
})
同步 API
我們約定,以 Sync 結(jié)尾的 API 都是同步 API, 如 wx.setStorageSync,wx.getSystemInfoSync 等。此外,也有一些其他的同步 API,如 wx.createWorker,wx.getBackgroundAudioManager 等,詳情參見 API 文檔中的說明。
同步 API 的執(zhí)行結(jié)果可以通過函數(shù)返回值直接獲取,如果執(zhí)行出錯會拋出異常。
代碼示例
try {
wx.setStorageSync('key', 'value')
} catch (e) {
console.error(e)
}
異步 API
大多數(shù) API 都是異步 API,如 wx.request,wx.login 等。這類 API 接口通常都接受一個 Object 類型的參數(shù),這個參數(shù)都支持按需指定以下字段來接收接口調(diào)用結(jié)果:
Object 參數(shù)說明
| 參數(shù)名 | 類型 | 必填 | 說明 |
|---|---|---|---|
| success | function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) |
| fail | function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) |
| complete | function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會執(zhí)行) |
| 其他 | Any | - | 接口定義的其他參數(shù) |
回調(diào)函數(shù)的參數(shù)
success,fail,complete 函數(shù)調(diào)用時會傳入一個 Object 類型參數(shù),包含以下字段:
| 屬性 | 類型 | 說明 |
|---|---|---|
| errMsg | string | 錯誤信息,如果調(diào)用成功返回 ${apiName}:ok |
| errCode | number | 錯誤碼,僅部分 API 支持,具體含義請參考對應(yīng) API 文檔,成功時為 0。 |
| 其他 | Any | 接口返回的其他數(shù)據(jù) |
異步 API 的執(zhí)行結(jié)果需要通過 Object 類型的參數(shù)中傳入的對應(yīng)回調(diào)函數(shù)獲取。部分異步 API 也會有返回值,可以用來實現(xiàn)更豐富的功能,如 wx.request,wx.connectSocket 等。
代碼示例
wx.login({
success(res) {
console.log(res.code)
}
})
異步 API 返回 Promise
基礎(chǔ)庫 2.10.2 版本起,異步 API 支持 callback & promise 兩種調(diào)用方式。當接口參數(shù) Object 對象中不包含 success/fail/complete 時將默認返回 promise,否則仍按回調(diào)方式執(zhí)行,無返回值。
注意事項
- 部分接口如 downloadFile, request, uploadFile, connectSocket, createCamera(小游戲)本身就有返回值, 它們的 promisify 需要開發(fā)者自行封裝。
- 當沒有回調(diào)參數(shù)時,異步接口返回 promise。此時若函數(shù)調(diào)用失敗進入 fail 邏輯, 會報錯提示 Uncaught (in promise),開發(fā)者可通過 catch 來進行捕獲。
- wx.onUnhandledRejection 可以監(jiān)聽未處理的 Promise 拒絕事件。
代碼示例
// callback 形式調(diào)用
wx.chooseImage({
success(res) {
console.log('res:', res)
}
})
// promise 形式調(diào)用
wx.chooseImage().then(res => console.log('res: ', res)) 網(wǎng)頁題目:創(chuàng)新互聯(lián)小程序教程:微信小程序API
標題URL:http://m.5511xx.com/article/dpdhdgp.html


咨詢
建站咨詢
