# 插件调用 API 的限制

插件可以调用的 API 与小程序不同,主要有两个区别:

  • 插件的请求域名列表与小程序相互独立;
  • 一些 API 不允许插件调用(这些函数不存在于 wx 对象下)。

有些接口虽然在插件中不能使用,但可以通过插件功能页来达到目的,请参考 插件功能页

各接口在插件中的支持情况可以在各接口的文档中确认,接口文档中会有如 「本接口从基础库 2.1.0 起支持在小程序插件中使用」 的标识;如果没有标识,说明插件暂未支持,如果有需要的具体使用场景和需求,可以在开发者社区中反馈。

以下表格汇总了目前插件可以调用的 API 及其对应版本要求,但这份表格已经不再更新,是否可以使用,请以具体接口文档中的说明和真机表现为准

插件支持接口情况参考汇总(表格已停止维护)

# 基础

# 发起请求

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.startRecord 1.9.6
wx.stopRecord 1.9.6

# 实时音视频

# 录音管理

API 最低版本 备注
wx.getRecorderManager 1.9.94

# 音频播放控制

# 音乐播放控制

# 背景音频播放管理

API 最低版本 备注
wx.getBackgroundAudioManager 1.9.6

# 音频组件控制

# 视频

# 视频组件控制

API 最低版本 备注
wx.createVideoContext 1.9.6

# 相机组件控制

API 最低版本 备注
wx.createCameraContext 1.9.6

# 数据缓存

# 获取位置

# 查看位置

API 最低版本 备注
wx.openLocation 1.9.6

# 地图组件控制

API 最低版本 备注
wx.createMapContext 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.makePhoneCall 1.9.6

# 扫码

API 最低版本 备注
wx.scanCode 1.9.6

# 剪贴板

# 蓝牙

# iBeacon

# Wi-Fi

# 交互反馈

# 设置导航条

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.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