微信小程序api開發(fā)者文檔,微信小程序api大全
2021-05-19
導(dǎo)讀：框架提供豐富的微信原生API，可以方便的調(diào)起微信提供的能力，如獲取用戶信息，本地存儲，支付功能等。...
API
框架提供豐富的微信原生API，可以方便的調(diào)起微信提供的能力，如獲取用戶信息，本地存儲，支付功能等。
說明：
- wx.on開頭的API是監(jiān)聽某個事件發(fā)生的API接口，接受一個CALLBACK函數(shù)作為參數(shù)。當該事件觸發(fā)時，會調(diào)用CALLBACK函數(shù)。
- 如未特殊約定，其他API接口都接受一個OBJECT作為參數(shù)。
- OBJECT中可以指定success,fail,complete來接收接口調(diào)用結(jié)果。
| 參數(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í)行） |
API列表：
網(wǎng)絡(luò)API列表：
| API | 說明 |
|---|---|
| wx.request | 發(fā)起網(wǎng)絡(luò)請求 |
| wx.uploadFile | 上傳文件 |
| wx.downloadFile | 下載文件 |
| wx.connectSocket | 創(chuàng)建WebSocket連接 |
| wx.onSocketOpen | 監(jiān)聽WebSocket打開 |
| wx.onSocketError | 監(jiān)聽WebSocket錯誤 |
| wx.sendSocketMessage | 發(fā)送WebSocket消息 |
| wx.onSocketMessage | 接受WebSocket消息 |
| wx.closeSocket | 關(guān)閉WebSocket連接 |
| wx.onSocketClose | 監(jiān)聽WebSocket關(guān)閉 |
媒體API列表：
| API | 說明 |
|---|---|
| wx.chooseImage | 從相冊選擇圖片，或者拍照 |
| wx.previewImage | 預(yù)覽圖片 |
| wx.startRecord | 開始錄音 |
| wx.stopRecord | 結(jié)束錄音 |
| wx.playVoice | 播放語音 |
| wx.pauseVoice | 暫停播放語音 |
| wx.stopVoice | 結(jié)束播放語音 |
| wx.getBackgroundAudioPlayerState | 獲取音樂播放狀態(tài) |
| wx.playBackgroundAudio | 播放音樂 |
| wx.pauseBackgroundAudio | 暫停播放音樂 |
| wx.seekBackgroundAudio | 控制音樂播放進度 |
| wx.stopBackgroundAudio | 停止播放音樂 |
| wx.onBackgroundAudioPlay | 監(jiān)聽音樂開始播放 |
| wx.onBackgroundAudioPause | 監(jiān)聽音樂暫停 |
| wx.onBackgroundAudioStop | 監(jiān)聽音樂結(jié)束 |
| wx.chooseVideo | 從相冊選擇視頻，或者拍攝 |
文件 API 列表：
| API | 說明 |
|---|---|
| wx.saveFile | 保存文件 |
| wx.getSavedFileList | 獲取已保存的文件列表 |
| wx.getSavedFileInfo | 獲取已保存的文件信息 |
| wx.removeSavedFile | 刪除已保存的文件信息 |
| wx.openDocument | 打開文件 |
數(shù)據(jù) API 列表：
| API | 說明 |
|---|---|
| wx.getStorage | 獲取本地數(shù)據(jù)緩存 |
| wx.getStorageSync | 獲取本地數(shù)據(jù)緩存 |
| wx.setStorage | 設(shè)置本地數(shù)據(jù)緩存 |
| wx.setStorageSync | 設(shè)置本地數(shù)據(jù)緩存 |
| wx.getStorageInfo | 獲取本地緩存的相關(guān)信息 |
| wx.getStorageInfoSync | 獲取本地緩存的相關(guān)信息 |
| wx.removeStorage | 刪除本地緩存內(nèi)容 |
| wx.removeStorageSync | 刪除本地緩存內(nèi)容 |
| wx.clearStorage | 清理本地數(shù)據(jù)緩存 |
| wx.clearStorageSync | 清理本地數(shù)據(jù)緩存 |
位置 API 列表：
| API | 說明 |
|---|---|
| wx.getLocation | 獲取當前位置 |
| wx.chooseLocation | 打開地圖選擇位置 |
| wx.openLocation | 打開內(nèi)置地圖 |
| wx.createMapContext | 地圖組件控制 |
設(shè)備 API 列表：
| API | 說明 |
|---|---|
| wx.getNetworkType | 獲取網(wǎng)絡(luò)類型 |
| wx.onNetworkStatusChange | 監(jiān)聽網(wǎng)絡(luò)狀態(tài)變化 |
| wx.getSystemInfo | 獲取系統(tǒng)信息 |
| wx.getSystemInfoSync | 獲取系統(tǒng)信息 |
| wx.onAccelerometerChange | 監(jiān)聽加速度數(shù)據(jù) |
| wx.startAccelerometer | 開始監(jiān)聽加速度數(shù)據(jù) |
| wx.stopAccelerometer | 停止監(jiān)聽加速度數(shù)據(jù) |
| wx.onCompassChange | 監(jiān)聽羅盤數(shù)據(jù) |
| wx.startCompass | 開始監(jiān)聽羅盤數(shù)據(jù) |
| wx.stopCompass | 停止監(jiān)聽羅盤數(shù)據(jù) |
| wx.setClipboardData | 設(shè)置剪貼板內(nèi)容 |
| wx.getClipboardData | 獲取剪貼板內(nèi)容 |
| wx.makePhoneCall | 撥打電話 |
| wx.scanCode | 掃碼 |
界面 API 列表：
| API | 說明 |
|---|---|
| wx.showToast | 顯示提示框 |
| wx.showLoading | 顯示加載提示框 |
| wx.hideToast | 隱藏提示框 |
| wx.hideLoading | 隱藏提示框 |
| wx.showModal | 顯示模態(tài)彈窗 |
| wx.showActionSheet | 顯示菜單列表 |
| wx.setNavigationBarTitle | 設(shè)置當前頁面標題 |
| wx.showNavigationBarLoading | 顯示導(dǎo)航條加載動畫 |
| wx.hideNavigationBarLoading | 隱藏導(dǎo)航條加載動畫 |
| wx.navigateTo | 新窗口打開頁面 |
| wx.redirectTo | 原窗口打開頁面 |
| wx.switchTab | 切換到 tabbar 頁面 |
| wx.navigateBack | 退回上一個頁面 |
| wx.createAnimation | 動畫 |
| wx.createCanvasContext | 創(chuàng)建繪圖上下文 |
| wx.drawCanvas | 繪圖 |
| wx.stopPullDownRefresh | 停止下拉刷新動畫 |
WXML節(jié)點信息 API 列表：
| API | 說明 |
|---|---|
| wx.createSelectorQuery | 創(chuàng)建查詢請求 |
| selectorQuery.select | 根據(jù)選擇器選擇單個節(jié)點 |
| selectorQuery.selectAll | 根據(jù)選擇器選擇全部節(jié)點 |
| selectorQuery.selectViewport | 選擇顯示區(qū)域 |
| nodesRef.boundingClientRect | 獲取布局位置和尺寸 |
| nodesRef.scrollOffset | 獲取滾動位置 |
| nodesRef.fields | 獲取任意字段 |
| selectorQuery.exec | 執(zhí)行查詢請求 |
開放接口：
| API | 說明 |
|---|---|
| wx.login | 登錄 |
| wx.getUserInfo | 獲取用戶信息 |
| wx.chooseAddress | 獲取用戶收貨地址 |
| wx.requestPayment | 發(fā)起微信支付 |
| wx.addCard | 添加卡券 |
| wx.openCard | 打開卡券 |
第二部分：如何開通一個小商店
掃碼免費領(lǐng)取運營資料包
