閱讀(7.6k) 書(shū)簽贊(0) 我要糾錯(cuò)

微信小程序插件調(diào)用API的限制

2022-05-11 15:39 更新

插件調(diào)用 API 的限制

插件可以調(diào)用的 API 與小程序不同，主要有兩個(gè)區(qū)別：

插件的請(qǐng)求域名列表與小程序相互獨(dú)立；
一些 API 不允許插件調(diào)用（這些函數(shù)不存在于 wx 對(duì)象下）。

有些接口雖然在插件中不能使用，但可以通過(guò)插件功能頁(yè)來(lái)達(dá)到目的，請(qǐng)參考插件功能頁(yè)。

目前，允許插件調(diào)用的 API 及其對(duì)應(yīng)版本要求如下：

基礎(chǔ)

API	最低版本	備注
wx.arrayBufferToBase64
wx.base64ToArrayBuffer

發(fā)起請(qǐng)求

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

實(shí)時(shí)音視頻

API	最低版本	備注
wx.createLivePlayerContext	1.9.6
wx.createLivePusherContext	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

音樂(lè)播放控制

API	最低版本	備注
wx.onBackgroundAudioPlay	1.9.6
wx.getBackgroundAudioPlayerState	1.9.6
wx.onBackgroundAudioStop	1.9.6
wx.stopBackgroundAudio	1.9.6
wx.onBackgroundAudioPause	1.9.6
wx.seekBackgroundAudio	1.9.6
wx.playBackgroundAudio	1.9.6
wx.pauseBackgroundAudio	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

相機(jī)組件控制

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.setKeepScreenOn	1.9.6
wx.setScreenBrightness	1.9.6
wx.getScreenBrightness	1.9.6

用戶(hù)截屏事件

API	最低版本	備注
wx.onUserCaptureScreen	1.9.6	僅限插件頁(yè)面中調(diào)用
wx.offUserCaptureScreen	2.9.1	僅限插件頁(yè)面中調(diào)用

振動(dòng)

API	最低版本	備注
wx.vibrateLong	1.9.6
wx.vibrateShort	1.9.6

手機(jī)聯(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.onNetworkStatusChange	1.9.6
wx.offNetworkStatusChange	2.9.1
wx.getNetworkType	1.9.6

加速度計(jì)

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

羅盤(pán)

API	最低版本	備注
wx.onCompassChange	1.9.6
wx.offCompassChange	2.9.1
wx.stopCompass	1.9.6
wx.startCompass	1.9.6

撥打電話(huà)

API	最低版本	備注
wx.makePhoneCall	1.9.6

掃碼

API	最低版本	備注
wx.scanCode	1.9.6

剪貼板

API	最低版本	備注
wx.setClipboardData	1.9.6
wx.getClipboardData	1.9.6

藍(lán)牙

API	最低版本	備注
wx.writeBLECharacteristicValue	1.9.6
wx.startBluetoothDevicesDiscovery	1.9.6
wx.getConnectedBluetoothDevices	1.9.6
wx.notifyBLECharacteristicValueChange	1.9.6
wx.onBluetoothDeviceFound	1.9.6
wx.offBluetoothDeviceFound	2.9.1
wx.readBLECharacteristicValue	1.9.6
wx.openBluetoothAdapter	1.9.6
wx.getBLEDeviceCharacteristics	1.9.6
wx.stopBluetoothDevicesDiscovery	1.9.6
wx.onBLEConnectionStateChange	1.9.6
wx.getBluetoothDevices	1.9.6
wx.getBluetoothAdapterState	1.9.6
wx.onBluetoothAdapterStateChange	1.9.6
wx.offBluetoothAdapterStateChange	2.9.1
wx.getBLEDeviceServices	1.9.6
wx.onBLECharacteristicValueChange	1.9.6
wx.offBLECharacteristicValueChange	2.9.1
wx.createBLEConnection	1.9.6
wx.closeBluetoothAdapter	1.9.6
wx.closeBLEConnection	1.9.6
wx.notifyBLECharacteristicValueChange	1.9.6
wx.onBLEConnectionStateChange	1.9.6
wx.offBLEConnectionStateChange	2.9.1

iBeacon

API	最低版本	備注
wx.getBeacons	1.9.6
wx.startBeaconDiscovery	1.9.6
wx.onBeaconServiceChange	1.9.6
wx.offBeaconServiceChange	2.9.1
wx.onBeaconUpdate	1.9.6
wx.offBeaconUpdate	2.9.1
wx.stopBeaconDiscovery	1.9.6

Wi-Fi

API	最低版本	備注
wx.connectWifi	2.9.1
wx.getConnectedWifi	2.9.1
wx.getWifiList	2.9.1
wx.offGetWifiList	2.9.1
wx.offWifiConnected	2.9.1
wx.onEvaluateWifi	2.9.1
wx.onGetWifiList	2.9.1
wx.onWifiConnected	2.9.1
wx.presetWifiList	2.9.1
wx.setWifiList	2.9.1
wx.startWifi	2.9.1
wx.stopWifi	2.9.1

交互反饋

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	僅限插件頁(yè)面中調(diào)用
wx.hideNavigationBarLoading	2.1.0	僅限插件頁(yè)面中調(diào)用
wx.setNavigationBarColor	2.1.0	僅限插件頁(yè)面中調(diào)用
wx.setNavigationBarTitle	2.1.0	僅限插件頁(yè)面中調(diào)用

背景

API	最低版本	備注
wx.setBackgroundColor	2.4.0	僅限插件頁(yè)面中調(diào)用
wx.setBackgroundTextStyle	2.4.0	僅限插件頁(yè)面中調(diào)用

WXML節(jié)點(diǎn)信息

API	最低版本	備注
wx.createSelectorQuery	1.9.6

WXML節(jié)點(diǎn)布局相交狀態(tài)

API	最低版本	備注
wx.createIntersectionObserver	1.9.6

導(dǎo)航

API	最低版本	備注
wx.navigateBack	2.1.0	僅限插件頁(yè)面中調(diào)用
wx.navigateTo	2.2.2	僅限插件頁(yè)面中調(diào)用
wx.redirectTo	2.2.2	僅限插件頁(yè)面中調(diào)用
wx.switchTab	2.3.1	僅限插件頁(yè)面中調(diào)用
wx.reLaunch	2.3.1	僅限插件頁(yè)面中調(diào)用

動(dòng)畫(huà)

API	最低版本	備注
wx.createAnimation	1.9.6

位置

API	最低版本	備注
wx.pageScrollTo	2.1.0	僅限插件頁(yè)面中調(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	僅限插件頁(yè)面中調(diào)用
wx.startPullDownRefresh	2.1.0	僅限插件頁(yè)面中調(diào)用

當(dāng)前帳號(hào)信息

API	最低版本	備注
wx.getAccountInfoSync	2.2.2

轉(zhuǎn)發(fā)

API	最低版本	備注
wx.hideShareMenu	2.1.0	僅限插件頁(yè)面中調(diào)用
wx.getShareInfo	2.1.0	僅限插件頁(yè)面中調(diào)用
wx.showShareMenu	2.1.0	僅限插件頁(yè)面中調(diào)用
wx.updateShareMenu	2.1.0	僅限插件頁(yè)面中調(diào)用

其他

API	最低版本	備注
wx.getSetting	2.6.3
wx.openSetting	2.10.3
wx.reportAnalytics	1.9.6	見(jiàn)下方備注

登錄和獲取用戶(hù)信息

這一組接口僅限在用戶(hù)信息功能頁(yè)中獲得用戶(hù)授權(quán)之后調(diào)用。否則將返回 fail 。詳見(jiàn) 用戶(hù)信息功能頁(yè) 。

API	最低版本	備注
wx.login	2.3.1
wx.getUserInfo	2.3.1

提示：

wx.reportAnalytics 可以被正常調(diào)用，但目前不會(huì)進(jìn)行統(tǒng)計(jì)展示。

以上內(nèi)容是否對(duì)您有幫助：

← 微信小程序使用插件

微信小程序插件使用組件的限制 →

寫(xiě)筆記

我要補(bǔ)充

微信小程序 插件調(diào)用API的限制