微信小程序 API

2018-10-30 14:35 更新

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ù)名類型必填說明
successFunction接口調(diào)用成功的回調(diào)函數(shù)
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(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打開卡券

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

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號