插件调用 API 的限制
插件可以调用的 API 与小程序不同，主要有两个区别：
- 插件的请求域名列表与小程序相互独立；
- 一些 API 不允许插件调用（这些函数不存在于
wx对象下）。
有些接口虽然在插件中不能使用，但可以通过插件功能页来达到目的，请参考 插件功能页。
各接口在插件中的支持情况可以在各接口的文档中确认，接口文档中会有如 「本接口从基础库 2.1.0 起支持在小程序插件中使用」 的标识；如果没有标识，说明插件暂未支持，如果有需要的具体使用场景和需求，可以在开发者社区中反馈。
以下表格汇总了目前插件可以调用的 API 及其对应版本要求，但这份表格已经不再更新，是否可以使用，请以具体接口文档中的说明和真机表现为准。
插件支持接口情况参考汇总（表格已停止维护）
基础
| API | 最低版本 | 备注 |
|---|---|---|
| bl.arrayBufferToBase64 | ||
| bl.base64ToArrayBuffer |
发起请求
| API | 最低版本 | 备注 |
|---|---|---|
| bl.request |
上传、下载
| API | 最低版本 | 备注 |
|---|---|---|
| bl.downloadFile | ||
| bl.uploadFile |
WebSocket
| API | 最低版本 | 备注 |
|---|---|---|
| bl.connectSocket |
图片
| API | 最低版本 | 备注 |
|---|---|---|
| bl.previewImage | ||
| bl.chooseImage | ||
| bl.getImageInfo | ||
| bl.saveImageToPhotosAlbum |
录音
| API | 最低版本 | 备注 |
|---|---|---|
| bl.startRecord | ||
| bl.stopRecord |
实时音视频
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createLivePlayerContext | ||
| bl.createLivePusherContext |
录音管理
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getRecorderManager |
音频播放控制
| API | 最低版本 | 备注 |
|---|---|---|
| bl.pauseVoice | ||
| bl.playVoice | ||
| bl.stopVoice |
音乐播放控制
背景音频播放管理
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getBackgroundAudioManager |
音频组件控制
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createInnerAudioContext | ||
| bl.createAudioContext |
视频
| API | 最低版本 | 备注 |
|---|---|---|
| bl.chooseVideo | ||
| bl.saveVideoToPhotosAlbum |
视频组件控制
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createVideoContext |
相机组件控制
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createCameraContext |
数据缓存
| API | 最低版本 | 备注 |
|---|---|---|
| bl.setStorage | ||
| bl.getStorage | ||
| bl.removeStorage | ||
| bl.setStorageSync | ||
| bl.getStorageSync | ||
| bl.removeStorageSync |
获取位置
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getLocation | ||
| bl.chooseLocation | ||
| bl.onLocationChange | ||
| bl.offLocationChange | ||
| bl.stopLocationUpdate | ||
| bl.startLocationUpdate |
查看位置
| API | 最低版本 | 备注 |
|---|---|---|
| bl.openLocation |
地图组件控制
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createMapContext |
系统信息
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getSystemInfoSync | ||
| bl.getSystemInfo |
屏幕亮度
| API | 最低版本 | 备注 |
|---|---|---|
| bl.setKeepScreenOn | ||
| bl.setScreenBrightness | ||
| bl.getScreenBrightness |
用户截屏事件
| API | 最低版本 | 备注 |
|---|---|---|
| bl.onUserCaptureScreen | 仅限插件页面中调用 | |
| bl.offUserCaptureScreen | 仅限插件页面中调用 |
振动
| API | 最低版本 | 备注 |
|---|---|---|
| bl.vibrateLong | ||
| bl.vibrateShort |
手机联系人
| API | 最低版本 | 备注 |
|---|---|---|
| bl.addPhoneContact |
NFC
| API | 最低版本 | 备注 |
|---|---|---|
| bl.sendHCEMessage | ||
| bl.stopHCE | ||
| bl.onHCEMessage | ||
| bl.offHCEMessage | ||
| bl.startHCE | ||
| bl.getHCEState |
网络状态
| API | 最低版本 | 备注 |
|---|---|---|
| bl.onNetworkStatusChange | ||
| bl.offNetworkStatusChange | ||
| bl.getNetworkType |
加速度计
| API | 最低版本 | 备注 |
|---|---|---|
| bl.startAccelerometer | ||
| bl.stopAccelerometer | ||
| bl.onAccelerometerChange | ||
| bl.offAccelerometerChange |
设备方向
| API | 最低版本 | 备注 |
|---|---|---|
| bl.startDeviceMotionListening | ||
| bl.stopDeviceMotionListening | ||
| bl.offDeviceMotionChange | ||
| bl.onDeviceMotionChange |
陀螺仪
| API | 最低版本 | 备注 |
|---|---|---|
| bl.startGyroscope | ||
| bl.stopGyroscope | ||
| bl.offGyroscopeChange | ||
| bl.onGyroscopeChange |
罗盘
| API | 最低版本 | 备注 |
|---|---|---|
| bl.onCompassChange | ||
| bl.offCompassChange | ||
| bl.stopCompass | ||
| bl.startCompass |
拨打电话
| API | 最低版本 | 备注 |
|---|---|---|
| bl.makePhoneCall |
扫码
| API | 最低版本 | 备注 |
|---|---|---|
| bl.scanCode |
剪贴板
| API | 最低版本 | 备注 |
|---|---|---|
| bl.setClipboardData | ||
| bl.getClipboardData |
蓝牙
iBeacon
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getBeacons | ||
| bl.startBeaconDiscovery | ||
| bl.onBeaconServiceChange | ||
| bl.offBeaconServiceChange | ||
| bl.onBeaconUpdate | ||
| bl.offBeaconUpdate | ||
| bl.stopBeaconDiscovery |
Wi-Fi
交互反馈
| API | 最低版本 | 备注 |
|---|---|---|
| bl.hideLoading | ||
| bl.showActionSheet | ||
| bl.showLoading | ||
| bl.hideToast | ||
| bl.showToast | ||
| bl.showModal |
设置导航条
| API | 最低版本 | 备注 |
|---|---|---|
| bl.showNavigationBarLoading | 仅限插件页面中调用 | |
| bl.hideNavigationBarLoading | 仅限插件页面中调用 | |
| bl.setNavigationBarColor | 仅限插件页面中调用 | |
| bl.setNavigationBarTitle | 仅限插件页面中调用 |
背景
| API | 最低版本 | 备注 |
|---|---|---|
| bl.setBackgroundColor | 仅限插件页面中调用 | |
| bl.setBackgroundTextStyle | 仅限插件页面中调用 |
WXML 节点信息
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createSelectorQuery |
WXML 节点布局相交状态
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createIntersectionObserver |
导航
| API | 最低版本 | 备注 |
|---|---|---|
| bl.navigateBack | 仅限插件页面中调用 | |
| bl.navigateTo | 仅限插件页面中调用 | |
| bl.redirectTo | 仅限插件页面中调用 | |
| bl.switchTab | 仅限插件页面中调用 | |
| bl.reLaunch | 仅限插件页面中调用 |
动画
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createAnimation |
位置
| API | 最低版本 | 备注 |
|---|---|---|
| bl.pageScrollTo | 仅限插件页面中调用 |
绘图
| API | 最低版本 | 备注 |
|---|---|---|
| bl.createOffscreenCanvas | ||
| bl.canvasPutImageData | ||
| bl.canvasToTempFilePath | ||
| bl.createCanvasContext | ||
| bl.canvasGetImageData |
下拉刷新
| API | 最低版本 | 备注 |
|---|---|---|
| bl.stopPullDownRefresh | 仅限插件页面中调用 | |
| bl.startPullDownRefresh | 仅限插件页面中调用 |
当前账号信息
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getAccountInfoSync |
转发
| API | 最低版本 | 备注 |
|---|---|---|
| bl.hideShareMenu | 仅限插件页面中调用 | |
| bl.getShareInfo | 仅限插件页面中调用 | |
| bl.showShareMenu | 仅限插件页面中调用 | |
| bl.updateShareMenu | 仅限插件页面中调用 |
实时日志
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getRealtimeLogManager |
其他
| API | 最低版本 | 备注 |
|---|---|---|
| bl.getSetting | ||
| bl.openSetting | ||
| bl.reportAnalytics | 见下方备注 |
登录和获取用户信息
这一组接口仅限在用户信息功能页中获得用户授权之后调用。否则将返回 fail 。详见 用户信息功能页 。
| API | 最低版本 | 备注 |
|---|---|---|
| bl.login | ||
| bl.getUserInfo |
Bugs & Tips
- bl.reportAnalytics 可以被正常调用，但目前不会进行统计展示。