插件调用 API 的限制
插件可以调用的 API 与小程序不同，主要有两个区别：
- 插件的请求域名列表与小程序相互独立；
- 一些 API 不允许插件调用（这些函数不存在于
wx 对象下）。
有些接口虽然在插件中不能使用，但可以通过插件功能页来达到目的，请参考 插件功能页。
各接口在插件中的支持情况可以在各接口的文档中确认，接口文档中会有如 「本接口从基础库 2.1.0 起支持在小程序插件中使用」 的标识；如果没有标识，说明插件暂未支持，如果有需要的具体使用场景和需求，可以在开发者社区中反馈。
以下表格汇总了目前插件可以调用的 API 及其对应版本要求，但这份表格已经不再更新，是否可以使用，请以具体接口文档中的说明和真机表现为准。
插件支持接口情况参考汇总（表格已停止维护）
基础
| API | 最低版本 | 备注 |
|---|
| wx.arrayBufferToBase64 | | |
| wx.base64ToArrayBuffer | | |
发起请求
| 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.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 | |
音乐播放控制
| 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 | |
相机组件控制
| API | 最低版本 | 备注 |
|---|
| wx.createCameraContext | 1.9.6 | |
数据缓存
| 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 | |
系统信息
| 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 | |
用户截屏事件
| API | 最低版本 | 备注 |
|---|
| wx.onUserCaptureScreen | 1.9.6 | 仅限插件页面中调用 |
| wx.offUserCaptureScreen | 2.9.1 | 仅限插件页面中调用 |
振动
| API | 最低版本 | 备注 |
|---|
| wx.vibrateLong | 1.9.6 | |
| wx.vibrateShort | 1.9.6 | |
手机联系人
| 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 | |
网络状态
| API | 最低版本 | 备注 |
|---|
| wx.onNetworkStatusChange | 1.9.6 | |
| wx.offNetworkStatusChange | 2.9.1 | |
| wx.getNetworkType | 1.9.6 | |
加速度计
| API | 最低版本 | 备注 |
|---|
| wx.startAccelerometer | 1.9.6 | |
| wx.stopAccelerometer | 1.9.6 | |
| wx.onAccelerometerChange | 1.9.6 | |
| wx.offAccelerometerChange | 2.9.1 | |
设备方向
| 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 | |
蓝牙
| 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 | |
设置导航条
| API | 最低版本 | 备注 |
|---|
| wx.showNavigationBarLoading | 2.1.0 | 仅限插件页面中调用 |
| wx.hideNavigationBarLoading | 2.1.0 | 仅限插件页面中调用 |
| wx.setNavigationBarColor | 2.1.0 | 仅限插件页面中调用 |
| wx.setNavigationBarTitle | 2.1.0 | 仅限插件页面中调用 |
背景
| API | 最低版本 | 备注 |
|---|
| wx.setBackgroundColor | 2.4.0 | 仅限插件页面中调用 |
| wx.setBackgroundTextStyle | 2.4.0 | 仅限插件页面中调用 |
WXML 节点信息
| API | 最低版本 | 备注 |
|---|
| wx.createSelectorQuery | 1.9.6 | |
WXML 节点布局相交状态
| API | 最低版本 | 备注 |
|---|
| wx.createIntersectionObserver | 1.9.6 | |
导航
| API | 最低版本 | 备注 |
|---|
| wx.navigateBack | 2.1.0 | 仅限插件页面中调用 |
| wx.navigateTo | 2.2.2 | 仅限插件页面中调用 |
| wx.redirectTo | 2.2.2 | 仅限插件页面中调用 |
| wx.switchTab | 2.3.1 | 仅限插件页面中调用 |
| wx.reLaunch | 2.3.1 | 仅限插件页面中调用 |
动画
| API | 最低版本 | 备注 |
|---|
| wx.createAnimation | 1.9.6 | |
位置
| API | 最低版本 | 备注 |
|---|
| wx.pageScrollTo | 2.1.0 | 仅限插件页面中调用 |
绘图
| 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 | 仅限插件页面中调用 |
| wx.startPullDownRefresh | 2.1.0 | 仅限插件页面中调用 |
当前帐号信息
| API | 最低版本 | 备注 |
|---|
| wx.getAccountInfoSync | 2.2.2 | |
转发
| API | 最低版本 | 备注 |
|---|
| wx.hideShareMenu | 2.1.0 | 仅限插件页面中调用 |
| wx.getShareInfo | 2.1.0 | 仅限插件页面中调用 |
| wx.showShareMenu | 2.1.0 | 仅限插件页面中调用 |
| wx.updateShareMenu | 2.1.0 | 仅限插件页面中调用 |
实时日志
| API | 最低版本 | 备注 |
|---|
| wx.getRealtimeLogManager | 2.16.0 | |
其他
| API | 最低版本 | 备注 |
|---|
| wx.getSetting | 2.6.3 | |
| wx.openSetting | 2.10.3 | |
| wx.reportAnalytics | 1.9.6 | 见下方备注 |
登录和获取用户信息
这一组接口仅限在用户信息功能页中获得用户授权之后调用。否则将返回 fail 。详见 用户信息功能页 。
| API | 最低版本 | 备注 |
|---|
| wx.login | 2.3.1 | |
| wx.getUserInfo | 2.3.1 | |
Bugs & Tips
- wx.reportAnalytics 可以被正常调用，但目前不会进行统计展示。
