# 插件調(diào)用 API 的限制
插件可以調(diào)用的 API 與小程序不同,主要有兩個區(qū)別:
- 插件的請求域名列表與小程序相互獨立;
- 一些 API 不允許插件調(diào)用(這些函數(shù)不存在于
wx對象下)。
有些接口雖然在插件中不能使用,但可以通過插件功能頁來達到目的,請參考 插件功能頁。
各接口在插件中的支持情況可以在各接口的文檔中確認,接口文檔中會有如 「本接口從基礎(chǔ)庫 2.1.0 起支持在小程序插件中使用」 的標識;如果沒有標識,說明插件暫未支持,如果有需要的具體使用場景和需求,可以在開發(fā)者社區(qū)中反饋。
以下表格匯總了目前插件可以調(diào)用的 API 及其對應(yīng)版本要求,但這份表格已經(jīng)不再更新,是否可以使用,請以具體接口文檔中的說明和真機表現(xiàn)為準。
插件支持接口情況參考匯總(表格已停止維護)
# 基礎(chǔ)
| API | 最低版本 | 備注 |
|---|---|---|
| wx.arrayBufferToBase64 | ||
| wx.base64ToArrayBuffer |
# 發(fā)起請求
| API | 最低版本 | 備注 |
|---|---|---|
| wx.request | 1.9.6 |
# 上傳、下載
| API | 最低版本 | 備注 |
|---|---|---|
| wx.downloadFile | 1.9.6 | |
| wx.uploadFile | 1.9.6 |
# WebSocket
| API | 最低版本 | 備注 |
|---|---|---|
| wx.connectSocket | 1.9.6 |
# 圖片
| API | 最低版本 | 備注 |
|---|---|---|
| wx.previewImage | 1.9.6 | |
| wx.chooseImage | 1.9.6 | |
| wx.getImageInfo | 1.9.6 | |
| wx.saveImageToPhotosAlbum | 1.9.6 |
# 錄音
| API | 最低版本 | 備注 |
|---|---|---|
| wx.startRecord | 1.9.6 | |
| wx.stopRecord | 1.9.6 |
# 實時音視頻
# 錄音管理
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getRecorderManager | 1.9.94 |
# 音頻播放控制
| API | 最低版本 | 備注 |
|---|---|---|
| wx.pauseVoice | 1.9.6 | |
| wx.playVoice | 1.9.6 | |
| wx.stopVoice | 1.9.6 |
# 音樂播放控制
# 背景音頻播放管理
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getBackgroundAudioManager | 1.9.6 |
# 音頻組件控制
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createInnerAudioContext | 1.9.6 | |
| wx.createAudioContext | 1.9.6 |
# 視頻
| API | 最低版本 | 備注 |
|---|---|---|
| wx.chooseVideo | 1.9.6 | |
| wx.saveVideoToPhotosAlbum | 1.9.6 |
# 視頻組件控制
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createVideoContext | 1.9.6 |
# 相機組件控制
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createCameraContext | 1.9.6 |
# 數(shù)據(jù)緩存
| API | 最低版本 | 備注 |
|---|---|---|
| wx.setStorage | 1.9.6 | |
| wx.getStorage | 1.9.6 | |
| wx.removeStorage | 1.9.6 | |
| wx.setStorageSync | 1.9.6 | |
| wx.getStorageSync | 1.9.6 | |
| wx.removeStorageSync | 1.9.6 |
# 獲取位置
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getLocation | 1.9.6 | |
| wx.chooseLocation | 1.9.6 | |
| wx.onLocationChange | 2.8.0 | |
| wx.offLocationChange | 2.9.1 | |
| wx.stopLocationUpdate | 2.8.0 | |
| wx.startLocationUpdate | 2.8.0 |
# 查看位置
| API | 最低版本 | 備注 |
|---|---|---|
| wx.openLocation | 1.9.6 |
# 地圖組件控制
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createMapContext | 1.9.6 |
# 系統(tǒng)信息
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getSystemInfoSync | 1.9.6 | |
| wx.getSystemInfo | 1.9.6 |
# 屏幕亮度
# 用戶截屏事件
| API | 最低版本 | 備注 |
|---|---|---|
| wx.onUserCaptureScreen | 1.9.6 | 僅限插件頁面中調(diào)用 |
| wx.offUserCaptureScreen | 2.9.1 | 僅限插件頁面中調(diào)用 |
# 振動
| API | 最低版本 | 備注 |
|---|---|---|
| wx.vibrateLong | 1.9.6 | |
| wx.vibrateShort | 1.9.6 |
# 手機聯(lián)系人
| API | 最低版本 | 備注 |
|---|---|---|
| wx.addPhoneContact | 1.9.6 |
# NFC
| API | 最低版本 | 備注 |
|---|---|---|
| wx.sendHCEMessage | 2.1.0 | |
| wx.stopHCE | 2.1.0 | |
| wx.onHCEMessage | 2.1.0 | |
| wx.offHCEMessage | 2.9.1 | |
| wx.startHCE | 2.1.0 | |
| wx.getHCEState | 2.1.0 |
# 網(wǎng)絡(luò)狀態(tài)
# 加速度計
| API | 最低版本 | 備注 |
|---|---|---|
| wx.startAccelerometer | 1.9.6 | |
| wx.stopAccelerometer | 1.9.6 | |
| wx.onAccelerometerChange | 1.9.6 | |
| wx.offAccelerometerChange | 2.9.1 |
# 設(shè)備方向
| API | 最低版本 | 備注 |
|---|---|---|
| wx.startDeviceMotionListening | 2.9.1 | |
| wx.stopDeviceMotionListening | 2.9.1 | |
| wx.offDeviceMotionChange | 2.9.1 | |
| wx.onDeviceMotionChange | 2.9.1 |
# 陀螺儀
| API | 最低版本 | 備注 |
|---|---|---|
| wx.startGyroscope | 2.9.1 | |
| wx.stopGyroscope | 2.9.1 | |
| wx.offGyroscopeChange | 2.9.1 | |
| wx.onGyroscopeChange | 2.9.1 |
# 羅盤
| API | 最低版本 | 備注 |
|---|---|---|
| wx.onCompassChange | 1.9.6 | |
| wx.offCompassChange | 2.9.1 | |
| wx.stopCompass | 1.9.6 | |
| wx.startCompass | 1.9.6 |
# 撥打電話
| API | 最低版本 | 備注 |
|---|---|---|
| wx.makePhoneCall | 1.9.6 |
# 掃碼
| API | 最低版本 | 備注 |
|---|---|---|
| wx.scanCode | 1.9.6 |
# 剪貼板
| API | 最低版本 | 備注 |
|---|---|---|
| wx.setClipboardData | 1.9.6 | |
| wx.getClipboardData | 1.9.6 |
# 藍牙
# iBeacon
# Wi-Fi
# 交互反饋
| API | 最低版本 | 備注 |
|---|---|---|
| wx.hideLoading | 1.9.6 | |
| wx.showActionSheet | 1.9.6 | |
| wx.showLoading | 1.9.6 | |
| wx.hideToast | 1.9.6 | |
| wx.showToast | 1.9.6 | |
| wx.showModal | 1.9.6 |
# 設(shè)置導(dǎo)航條
| API | 最低版本 | 備注 |
|---|---|---|
| wx.showNavigationBarLoading | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.hideNavigationBarLoading | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.setNavigationBarColor | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.setNavigationBarTitle | 2.1.0 | 僅限插件頁面中調(diào)用 |
# 背景
| API | 最低版本 | 備注 |
|---|---|---|
| wx.setBackgroundColor | 2.4.0 | 僅限插件頁面中調(diào)用 |
| wx.setBackgroundTextStyle | 2.4.0 | 僅限插件頁面中調(diào)用 |
# WXML 節(jié)點信息
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createSelectorQuery | 1.9.6 |
# WXML 節(jié)點布局相交狀態(tài)
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createIntersectionObserver | 1.9.6 |
# 導(dǎo)航
| API | 最低版本 | 備注 |
|---|---|---|
| wx.navigateBack | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.navigateTo | 2.2.2 | 僅限插件頁面中調(diào)用 |
| wx.redirectTo | 2.2.2 | 僅限插件頁面中調(diào)用 |
| wx.switchTab | 2.3.1 | 僅限插件頁面中調(diào)用 |
| wx.reLaunch | 2.3.1 | 僅限插件頁面中調(diào)用 |
# 動畫
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createAnimation | 1.9.6 |
# 位置
| API | 最低版本 | 備注 |
|---|---|---|
| wx.pageScrollTo | 2.1.0 | 僅限插件頁面中調(diào)用 |
# 繪圖
| API | 最低版本 | 備注 |
|---|---|---|
| wx.createOffscreenCanvas | 2.7.1 | |
| wx.canvasPutImageData | 1.9.6 | |
| wx.canvasToTempFilePath | 1.9.6 | |
| wx.createCanvasContext | 1.9.6 | |
| wx.canvasGetImageData | 1.9.6 |
# 下拉刷新
| API | 最低版本 | 備注 |
|---|---|---|
| wx.stopPullDownRefresh | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.startPullDownRefresh | 2.1.0 | 僅限插件頁面中調(diào)用 |
# 當(dāng)前賬號信息
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getAccountInfoSync | 2.2.2 |
# 轉(zhuǎn)發(fā)
| API | 最低版本 | 備注 |
|---|---|---|
| wx.hideShareMenu | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.getShareInfo | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.showShareMenu | 2.1.0 | 僅限插件頁面中調(diào)用 |
| wx.updateShareMenu | 2.1.0 | 僅限插件頁面中調(diào)用 |
# 實時日志
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getRealtimeLogManager | 2.16.0 |
# 其他
| API | 最低版本 | 備注 |
|---|---|---|
| wx.getSetting | 2.6.3 | |
| wx.openSetting | 2.10.3 | |
| wx.reportAnalytics | 1.9.6 | 見下方備注 |
# 登錄和獲取用戶信息
這一組接口僅限在用戶信息功能頁中獲得用戶授權(quán)之后調(diào)用。否則將返回 fail 。詳見 用戶信息功能頁 。
| API | 最低版本 | 備注 |
|---|---|---|
| wx.login | 2.3.1 | |
| wx.getUserInfo | 2.3.1 |
# Bugs & Tips
- wx.reportAnalytics 可以被正常調(diào)用,但目前不會進行統(tǒng)計展示。