微信小程序API支持情况¶
基础¶
API |
说明 |
企业微信支持情况 |
|---|---|---|
wx.canIUse |
判断小程序的API，回调，参数，组件等是否在当前版本可用 |
支持 |
更新¶
API |
说明 |
企业微信支持情况 |
|---|---|---|
wx.getUpdateManager |
获取全局唯一的版本更新管理器，用于管理小程序更新 |
支持 |
UpdateManager¶
API |
说明 |
企业微信支持情况 |
|---|---|---|
UpdateManager.applyUpdate |
强制小程序重启并使用新版本 |
支持 |
UpdateManager.onCheckForUpdate |
监听向微信后台请求检查更新结果事件 |
支持 |
UpdateManager.onUpdateFailed |
监听小程序更新失败事件 |
支持 |
UpdateManager.onUpdateReady |
监听小程序有版本更新事件 |
支持 |
小程序¶
生命周期¶
API 说明 企业微信支持情况 wx.getLaunchOptionsSync 获取小程序启动时的参数 支持
应用级事件¶
API 说明 企业微信支持情况 wx.onPageNotFound 监听小程序要打开的页面不存在事件 支持 wx.onError 监听小程序错误事件 支持 wx.onAppShow 监听小程序切前台事件 支持 wx.onAppHide 监听小程序切后台事件 支持 wx.offPageNotFound 取消监听小程序要打开的页面不存在事件 支持 wx.offError 取消监听小程序错误事件 支持 wx.offAppShow 取消监听小程序切前台事件 支持 wx.offAppHide 取消监听小程序切后台事件 支持
定时器¶
API 说明 企业微信支持情况 clearInterval 取消由 setInterval 设置的定时器 支持 clearTimeout 取消由 setTimeout 设置的定时器 支持 setInterval 设定一个定时器 支持 setTimeout 设定一个定时器 支持
调试¶
API 说明 企业微信支持情况 wx.setEnableDebug 设置是否打开调试开关 支持 wx.getLogManager 获取日志管理器对象 支持
console¶
API 说明 企业微信支持情况 console.debug 向调试面板中打印 debug 日志 支持 console.error 向调试面板中打印 error 日志 支持 console.group 在调试面板中创建一个新的分组 支持 console.groupEnd 结束由 console.group 创建的分组 支持 console.info 向调试面板中打印 info 日志 支持 console.log 向调试面板中打印 log 日志 支持 console.warn 向调试面板中打印 warn 日志 支持
LogManager¶
API 说明 企业微信支持情况 LogManager.debug 写 debug 日志 支持 LogManager.info 写 info 日志 支持 LogManager.log 写 log 日志 支持 LogManager.warn 写 warn 日志 支持
路由¶
API 说明 企业微信支持情况 wx.switchTab 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 支持 wx.reLaunch 关闭所有页面，打开到应用内的某个页面 支持 wx.redirectTo 关闭当前页面，跳转到应用内的某个页面 支持 wx.navigateTo 保留当前页面，跳转到应用内的某个页面 支持 wx.navigateBack 关闭当前页面，返回上一页面或多级页面 支持
界面¶
交互¶
API 说明 企业微信支持情况 wx.showToast 显示消息提示框 支持 wx.showModal 显示模态对话框 支持 wx.showLoading 显示 loading 提示框 支持 wx.showActionSheet 显示操作菜单 支持 wx.hideToast 隐藏消息提示框 支持 wx.hideLoading 隐藏 loading 提示框 支持
导航栏¶
API 说明 企业微信支持情况 wx.showNavigationBarLoading 在当前页面显示导航条加载动画 支持 wx.setNavigationBarTitle 动态设置当前页面的标题 支持 wx.setNavigationBarColor 设置页面导航条颜色 支持 wx.hideNavigationBarLoading 在当前页面隐藏导航条加载动画 支持
背景¶
API 说明 企业微信支持情况 wx.setBackgroundTextStyle 动态设置下拉背景字体、loading 图的样式 支持 wx.setBackgroundColor 动态设置窗口的背景色 支持
Tab Bar¶
API 说明 企业微信支持情况 wx.showTabBarRedDot 显示 tabBar 某一项的右上角的红点 支持 wx.showTabBar 显示 tabBar 支持 wx.setTabBarStyle 动态设置 tabBar 的整体样式 支持 wx.setTabBarItem 动态设置 tabBar 某一项的内容 支持 wx.setTabBarBadge 为 tabBar 某一项的右上角添加文本 支持 wx.removeTabBarBadge 移除 tabBar 某一项右上角的文本 支持 wx.hideTabBarRedDot 隐藏 tabBar 某一项的右上角的红点 支持 wx.hideTabBar 隐藏 tabBar 支持
字体¶
API 说明 企业微信支持情况 wx.loadFontFace 动态加载网络字体 支持
下拉刷新¶
API |
说明 |
企业微信支持情况 |
|---|---|---|
wx.stopPullDownRefresh |
停止当前页面下拉刷新 |
支持 |
wx.startPullDownRefresh |
开始下拉刷新 |
支持 |
滚动¶
API 说明 企业微信支持情况 wx.pageScrollTo 将页面滚动到目标位置 支持
动画¶
API 说明 企业微信支持情况 wx.createAnimation 创建一个动画实例 animation 支持
Animation¶
API 说明 企业微信支持情况 Animation.backgroundColor 设置背景色 支持 Animation.bottom 设置 bottom 值 支持 Animation.export 导出动画队列 支持 Animation.height 设置高度 支持 Animation.left 设置 left 值 支持 Animation.matrix 同 transform-function matrix 支持 Animation.matrix3d 同 transform-function matrix3d 支持 Animation.opacity 设置透明度 支持 Animation.right 设置 right 值 支持 Animation.rotate 从原点顺时针旋转一个角度 支持 Animation.rotate3d 从 X 轴顺时针旋转一个角度 支持 Animation.rotateX 从 X 轴顺时针旋转一个角度 支持 Animation.rotateY 从 Y 轴顺时针旋转一个角度 支持 Animation.rotateZ 从 Z 轴顺时针旋转一个角度 支持 Animation.scale 缩放 支持 Animation.scale3d 缩放 支持 Animation.scaleX 缩放 X 轴 支持 Animation.scaleY 缩放 Y 轴 支持 Animation.scaleZ 缩放 Z 轴 支持 Animation.skew 对 X、Y 轴坐标进行倾斜 支持 Animation.skewX 对 X 轴坐标进行倾斜 支持 Animation.skewY 对 Y 轴坐标进行倾斜 支持 Animation.step 表示一组动画完成 支持 Animation.top 设置 top 值 支持 Animation.translate 平移变换 支持 Animation.translate3d 对 xyz 坐标进行平移变换 支持 Animation.translateX 对 X 轴平移 支持 Animation.translateY 对 Y 轴平移 支持 Animation.translateZ 对 Z 轴平移 支持 Animation.width 设置宽度 支持
置顶¶
API 说明 企业微信支持情况 wx.setTopBarText 动态设置置顶栏文字内容 不支持
自定义组件¶
API 说明 企业微信支持情况 wx.nextTick 延迟一部分操作到下一个时间片再执行 不支持
菜单¶
API 说明 企业微信支持情况 wx.getMenuButtonBoundingClientRect 获取菜单按钮（右上角胶囊按钮）的布局位置信息 支持
窗口¶
API 说明 企业微信支持情况 wx.onWindowResize 监听窗口尺寸变化事件 不支持 wx.offWindowResize 取消监听窗口尺寸变化事件 不支持
键盘¶
API 说明 企业微信支持情况 wx.onKeyboardHeightChange 监听键盘高度变化 不支持
网络¶
发起请求¶
API 说明 企业微信支持情况 wx.request 发起 HTTPS 网络请求 支持
RequestTask¶
API 说明 企业微信支持情况 RequestTask.abort 中断请求任务 支持 RequestTask.offHeadersReceived 取消监听 HTTP Response Header 事件 支持 RequestTask.onHeadersReceived 监听 HTTP Response Header 事件 支持
下载¶
API 说明 企业微信支持情况 wx.downloadFile 下载文件资源到本地 支持
DownloadTask¶
API 说明 企业微信支持情况 DownloadTask.abort 中断下载任务 支持 DownloadTask.offHeadersReceived 取消监听 HTTP Response Header 事件 支持 DownloadTask.offProgressUpdate 取消监听下载进度变化事件 支持 DownloadTask.onHeadersReceived 监听 HTTP Response Header 事件 支持 DownloadTask.onProgressUpdate 监听下载进度变化事件 支持
上传¶
API 说明 企业微信支持情况 wx.uploadFile 将本地资源上传到服务器 支持
UploadTask¶
API 说明 企业微信支持情况 UploadTask.abort 中断上传任务 支持 UploadTask.offHeadersReceived 取消监听 HTTP Response Header 事件 支持 UploadTask.offProgressUpdate 取消监听上传进度变化事件 支持 UploadTask.onHeadersReceived 监听 HTTP Response Header 事件 支持 UploadTask.onProgressUpdate 监听上传进度变化事件 支持
WebSocket¶
API 说明 企业微信支持情况 wx.sendSocketMessage 通过 WebSocket 连接发送数据 支持 wx.onSocketOpen 监听 WebSocket 连接打开事件 支持 wx.onSocketMessage 监听 WebSocket 接受到服务器的消息事件 支持 wx.onSocketError 监听 WebSocket 错误事件 支持 wx.onSocketClose 监听 WebSocket 连接关闭事件 支持 wx.connectSocket 创建一个 WebSocket 连接 支持 wx.closeSocket 关闭 WebSocket 连接 支持
SocketTask¶
API 说明 企业微信支持情况 SocketTask.close 关闭 WebSocket 连接 支持 SocketTask.onClose 监听 WebSocket 连接关闭事件 支持 SocketTask.onError 监听 WebSocket 错误事件 支持 SocketTask.onMessage 监听 WebSocket 接受到服务器的消息事件 支持 SocketTask.onOpen 监听 WebSocket 连接打开事件 支持 SocketTask.send 通过 WebSocket 连接发送数据 支持
mDNS¶
API 说明 企业微信支持情况 wx.stopLocalServiceDiscovery 停止搜索 mDNS 服务 不支持 wx.startLocalServiceDiscovery 开始搜索局域网下的 mDNS 服务 不支持 wx.onLocalServiceResolveFail 监听 mDNS 服务解析失败的事件 不支持 wx.onLocalServiceLost 监听 mDNS 服务离开的事件 不支持 wx.onLocalServiceFound 监听 mDNS 服务发现的事件 不支持 wx.onLocalServiceDiscoveryStop 监听 mDNS 服务停止搜索的事件 不支持 wx.offLocalServiceResolveFail 取消监听 mDNS 服务解析失败的事件 不支持 wx.offLocalServiceLost 取消监听 mDNS 服务离开的事件 不支持 wx.offLocalServiceFound 取消监听 mDNS 服务发现的事件 不支持 wx.offLocalServiceDiscoveryStop 取消监听 mDNS 服务停止搜索的事件 不支持
数据缓存¶
API 说明 企业微信支持情况 wx.setStorageSync wx.setStorage 的同步版本 支持 wx.setStorage 将数据存储在本地缓存中指定的 key 中 支持 wx.removeStorageSync wx.removeStorage 的同步版本 支持 wx.removeStorage 从本地缓存中移除指定 key 支持 wx.getStorageSync wx.getStorage 的同步版本 支持 wx.getStorageInfoSync wx.getStorageInfo 的同步版本 支持 wx.getStorageInfo 异步获取当前storage的相关信息 支持 wx.getStorage 从本地缓存中异步获取指定 key 的内容 支持 wx.clearStorageSync wx.clearStorage 的同步版本 支持 wx.clearStorage 清理本地数据缓存 支持
媒体¶
地图¶
API 说明 企业微信支持情况 wx.createMapContext 创建 map 上下文 MapContext 对象 支持
MapContext¶
API 说明 企业微信支持情况 MapContext.getCenterLocation 获取当前地图中心的经纬度 支持 MapContext.getRegion 获取当前地图的视野范围 支持 MapContext.getScale 获取当前地图的缩放级别 支持 MapContext.includePoints 缩放视野展示所有经纬度 支持 MapContext.moveToLocation 将地图中心移动到当前定位点 支持 MapContext.translateMarker 平移marker，带动画 iOS不支持动画
图片¶
API 说明 企业微信支持情况 wx.saveImageToPhotosAlbum 保存图片到系统相册 支持 wx.previewImage 在新页面中全屏预览图片 支持 wx.getImageInfo 获取图片信息 支持 wx.compressImage 压缩图片接口，可选压缩质量 支持 wx.chooseMessageFile 从客户端会话选择文件 不支持 wx.chooseImage 从本地相册选择图片或使用相机拍照 支持
视频¶
API 说明 企业微信支持情况 wx.saveVideoToPhotosAlbum 保存视频到系统相册 支持 wx.createVideoContext 创建 video 上下文 VideoContext 对象 支持 wx.chooseVideo 拍摄视频或从手机相册中选视频 支持
VideoContext¶
API 说明 企业微信支持情况 VideoContext.exitFullScreen 退出全屏 支持 VideoContext.hideStatusBar 隐藏状态栏，仅在iOS全屏下有效 支持 VideoContext.pause 暂停视频 支持 VideoContext.play 播放视频 支持 VideoContext.playbackRate 设置倍速播放 支持 VideoContext.requestFullScreen 进入全屏 支持 VideoContext.seek 跳转到指定位置 支持 VideoContext.sendDanmu 发送弹幕 支持 VideoContext.showStatusBar 显示状态栏，仅在iOS全屏下有效 支持 VideoContext.stop 停止视频 支持
音频¶
API 说明 企业微信支持情况 wx.stopVoice 结束播放语音 支持 wx.setInnerAudioOption 设置 InnerAudioContext 的播放选项 支持 wx.playVoice 开始播放语音 支持 wx.pauseVoice 暂停正在播放的语音 支持 wx.getAvailableAudioSources 获取当前支持的音频输入源 支持 wx.createInnerAudioContext 创建内部 audio 上下文 InnerAudioContext 对象 支持 wx.createAudioContext 创建 audio 上下文 AudioContext 对象 支持
AudioContext¶
API 说明 企业微信支持情况 AudioContext.pause 暂停音频 支持 AudioContext.play 播放音频 支持 AudioContext.seek 跳转到指定位置 支持 AudioContext.setSrc 设置音频地址 支持
InnerAudioContext¶
API 说明 企业微信支持情况 InnerAudioContext.destroy 销毁当前实例 支持 InnerAudioContext.offCanplay 取消监听音频进入可以播放状态的事件 支持 InnerAudioContext.offEnded 取消监听音频自然播放至结束的事件 支持 InnerAudioContext.offError 取消监听音频播放错误事件 支持 InnerAudioContext.offPause 取消监听音频暂停事件 支持 InnerAudioContext.offPlay 取消监听音频播放事件 支持 InnerAudioContext.offSeeked 取消监听音频完成跳转操作的事件 支持 InnerAudioContext.offSeeking 取消监听音频进行跳转操作的事件 支持 InnerAudioContext.offStop 取消监听音频停止事件 支持 InnerAudioContext.offTimeUpdate 取消监听音频播放进度更新事件 支持 InnerAudioContext.offWaiting 取消监听音频加载中事件 支持 InnerAudioContext.onCanplay 监听音频进入可以播放状态的事件 支持 InnerAudioContext.onEnded 监听音频自然播放至结束的事件 支持 InnerAudioContext.onError 监听音频播放错误事件 支持 InnerAudioContext.onPause 监听音频暂停事件 支持 InnerAudioContext.onPlay 监听音频播放事件 支持 InnerAudioContext.onSeeked 监听音频完成跳转操作的事件 支持 InnerAudioContext.onSeeking 监听音频进行跳转操作的事件 支持 InnerAudioContext.onStop 监听音频停止事件 支持 InnerAudioContext.onTimeUpdate 监听音频播放进度更新事件 支持 InnerAudioContext.onWaiting 监听音频加载中事件 支持 InnerAudioContext.pause 暂停 支持 InnerAudioContext.play 播放 支持 InnerAudioContext.seek 跳转到指定位置 支持 InnerAudioContext.stop 停止 支持
背景音频¶
API 说明 企业微信支持情况 wx.stopBackgroundAudio 停止播放音乐 不支持 wx.seekBackgroundAudio 控制音乐播放进度 不支持 wx.playBackgroundAudio 使用后台播放器播放音乐 不支持 wx.pauseBackgroundAudio 暂停播放音乐 不支持 wx.onBackgroundAudioStop 监听音乐停止事件 不支持 wx.onBackgroundAudioPlay 监听音乐播放事件 不支持 wx.onBackgroundAudioPause 监听音乐暂停事件 不支持 wx.getBackgroundAudioPlayerState 获取后台音乐播放状态 不支持 wx.getBackgroundAudioManager 获取全局唯一的背景音频管理器 不支持
API 说明 企业微信支持情况 BackgroundAudioManager.onCanplay 监听背景音频进入可播放状态事件 不支持 BackgroundAudioManager.onEnded 监听背景音频自然播放结束事件 不支持 BackgroundAudioManager.onError 监听背景音频播放错误事件 不支持 BackgroundAudioManager.onNext 监听用户在系统音乐播放面板点击下一曲事件（仅iOS） 不支持 BackgroundAudioManager.onPause 监听背景音频暂停事件 不支持 BackgroundAudioManager.onPlay 监听背景音频播放事件 不支持 BackgroundAudioManager.onPrev 监听用户在系统音乐播放面板点击上一曲事件（仅iOS） 不支持 BackgroundAudioManager.onSeeked 监听背景音频完成跳转操作事件 不支持 BackgroundAudioManager.onSeeking 监听背景音频开始跳转操作事件 不支持 BackgroundAudioManager.onStop 监听背景音频停止事件 不支持 BackgroundAudioManager.onTimeUpdate 监听背景音频播放进度更新事件 不支持 BackgroundAudioManager.onWaiting 监听音频加载中事件 不支持 BackgroundAudioManager.pause 暂停音乐 不支持 BackgroundAudioManager.play 播放音乐 不支持 BackgroundAudioManager.seek 跳转到指定位置 不支持 BackgroundAudioManager.stop 停止音乐 不支持
实时音视频¶
API 说明 企业微信支持情况 wx.createLivePusherContext 创建 live-pusher 上下文 LivePusherContext 对象 支持 wx.createLivePlayerContext 创建 live-player 上下文 LivePlayerContext 对象 支持
LivePlayerContext¶
API 说明 企业微信支持情况 LivePlayerContext.exitFullScreen 退出全屏 支持 LivePlayerContext.mute 静音 支持 LivePlayerContext.pause 暂停 支持 LivePlayerContext.play 播放 支持 LivePlayerContext.requestFullScreen 进入全屏 支持 LivePlayerContext.resume 恢复 支持 LivePlayerContext.stop 停止 支持
LivePusherContext¶
API 说明 企业微信支持情况 LivePusherContext.pause 暂停推流 支持 LivePusherContext.pauseBGM 暂停背景音 支持 LivePusherContext.playBGM 播放背景音 支持 LivePusherContext.resume 恢复推流 支持 LivePusherContext.resumeBGM 恢复背景音 支持 LivePusherContext.setBGMVolume 设置背景音音量 支持 LivePusherContext.snapshot 快照 支持 LivePusherContext.start 播放推流 支持 LivePusherContext.stop 停止推流 支持 LivePusherContext.stopBGM 停止背景音 支持 LivePusherContext.switchCamera 切换前后摄像头 支持 LivePusherContext.toggleTorch 切换 支持
录音¶
API 说明 企业微信支持情况 wx.stopRecord 停止录音 支持 wx.startRecord 开始录音 支持 wx.getRecorderManager 获取全局唯一的录音管理器 RecorderManager 支持
RecorderManager¶
API 说明 企业微信支持情况 RecorderManager.onError 监听录音错误事件 支持 RecorderManager.onFrameRecorded 监听已录制完指定帧大小的文件事件 支持 RecorderManager.onInterruptionBegin 监听录音因为受到系统占用而被中断开始事件 不支持 RecorderManager.onInterruptionEnd 监听录音中断结束事件 不支持 RecorderManager.onPause 监听录音暂停事件 支持 RecorderManager.onResume 监听录音继续事件 支持 RecorderManager.onStart 监听录音开始事件 支持 RecorderManager.onStop 监听录音结束事件 支持 RecorderManager.pause 暂停录音 支持 RecorderManager.resume 继续录音 支持 RecorderManager.start 开始录音 支持 RecorderManager.stop 停止录音 支持
相机¶
API 说明 企业微信支持情况 wx.createCameraContext 创建 camera 上下文 CameraContext 对象 不支持 CameraContext API 说明 企业微信支持情况 CameraContext.startRecord 开始录像 不支持 CameraContext.stopRecord 结束录像 不支持 CameraContext.takePhoto 拍摄照片 不支持
位置¶
API 说明 企业微信支持情况 wx.openLocation 使用微信内置地图查看位置 支持 wx.getLocation 获取当前的地理位置、速度 支持 wx.chooseLocation 打开地图选择位置 支持
转发¶
API 说明 企业微信支持情况 wx.updateShareMenu 更新转发属性 不支持 wx.showShareMenu 显示当前页面的转发按钮 不支持 withShareTicket 参数 wx.hideShareMenu 隐藏转发按钮 支持 wx.getShareInfo 获取转发详细信息 不支持 shareTicket 参数
画布¶
API 说明 企业微信支持情况 wx.createCanvasContext 创建 canvas 的绘图上下文 CanvasContext 对象 支持 wx.canvasToTempFilePath 把当前画布指定区域的内容导出生成指定大小的图片 支持 wx.canvasPutImageData 将像素数据绘制到画布 支持 wx.canvasGetImageData 获取 canvas 区域隐含的像素数据 支持
CanvasContext¶
API 说明 企业微信支持情况 CanvasContext.arc 创建一条弧线 支持 CanvasContext.arcTo 根据控制点和半径绘制圆弧路径 支持 CanvasContext.beginPath 开始创建一个路径 支持 CanvasContext.bezierCurveTo 创建三次方贝塞尔曲线路径 支持 CanvasContext.clearRect 清除画布上在该矩形区域内的内容 支持 CanvasContext.clip 从原始画布中剪切任意形状和尺寸 支持 CanvasContext.closePath 关闭一个路径 支持 CanvasContext.createCircularGradient 创建一个圆形的渐变颜色 支持 CanvasContext.createLinearGradient 创建一个线性的渐变颜色 支持 CanvasContext.createPattern 对指定的图像创建模式的方法，可在指定的方向上重复元图像 支持 CanvasContext.draw 将之前在绘图上下文中的描述（路径、变形、样式）画到 canvas 中 支持 CanvasContext.drawImage 绘制图像到画布 支持 CanvasContext.fill 对当前路径中的内容进行填充 支持 CanvasContext.fillRect 填充一个矩形 支持 CanvasContext.fillText 在画布上绘制被填充的文本 支持 CanvasContext.lineTo 增加一个新点，然后创建一条从上次指定点到目标点的线 支持 CanvasContext.measureText 测量文本尺寸信息 支持 CanvasContext.moveTo 把路径移动到画布中的指定点，不创建线条 支持 CanvasContext.quadraticCurveTo 创建二次贝塞尔曲线路径 支持 CanvasContext.rect 创建一个矩形路径 支持 CanvasContext.restore 恢复之前保存的绘图上下文 支持 CanvasContext.rotate 以原点为中心顺时针旋转当前坐标轴 支持 CanvasContext.save 保存绘图上下文 支持 CanvasContext.scale 在调用后，之后创建的路径其横纵坐标会被缩放 支持 CanvasContext.setFillStyle 设置填充色 支持 CanvasContext.setFontSize 设置字体的字号 支持 CanvasContext.setGlobalAlpha 设置全局画笔透明度 支持 CanvasContext.setLineCap 设置线条的端点样式 支持 CanvasContext.setLineDash 设置虚线样式 支持 CanvasContext.setLineJoin 设置线条的交点样式 支持 CanvasContext.setLineWidth 设置线条的宽度 支持 CanvasContext.setMiterLimit 设置最大斜接长度 支持 CanvasContext.setShadow 设定阴影样式 支持 CanvasContext.setStrokeStyle 设置描边颜色 支持 CanvasContext.setTextAlign 设置文字的对齐 支持 CanvasContext.setTextBaseline 设置文字的竖直对齐 支持 CanvasContext.setTransform 使用矩阵重新设置（覆盖）当前变换的方法 支持 CanvasContext.stroke 画出当前路径的边框 支持 CanvasContext.strokeRect 画一个矩形(非填充) 支持 CanvasContext.strokeText 给定的 (x, y) 位置绘制文本描边的方法 支持 CanvasContext.transform 使用矩阵多次叠加当前变换的方法 支持 CanvasContext.translate 对当前坐标系的原点 (0, 0) 进行变换 支持
CanvasGradient¶
API 说明 企业微信支持情况 CanvasGradient.addColorStop 添加颜色的渐变点 支持 Color 颜色 支持
文件¶
API 说明 企业微信支持情况 wx.saveFile 保存文件到本地 支持 wx.removeSavedFile 删除本地缓存文件 支持 wx.openDocument 新开页面打开文档 支持 wx.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 支持 wx.getSavedFileInfo 获取本地文件的文件信息 支持 wx.getFileSystemManager 获取全局唯一的文件管理器 支持 wx.getFileInfo 获取文件信息 支持
FileSystemManager¶
API 说明 企业微信支持情况 FileSystemManager.access 判断文件/目录是否存在 支持 FileSystemManager.accessSync FileSystemManager.access 的同步版本 支持 FileSystemManager.appendFile 在文件结尾追加内容 支持 FileSystemManager.appendFileSync FileSystemManager.appendFile 的同步版本 支持 FileSystemManager.copyFile 复制文件 支持 FileSystemManager.copyFileSync FileSystemManager.copyFile 的同步版本 支持 FileSystemManager.getFileInfo 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 支持 FileSystemManager.getSavedFileList 获取该小程序下已保存的本地缓存文件列表 支持 FileSystemManager.mkdir 创建目录 支持 FileSystemManager.mkdirSync FileSystemManager.mkdir 的同步版本 支持 FileSystemManager.readdir 读取目录内文件列表 支持 FileSystemManager.readdirSync FileSystemManager.readdir 的同步版本 支持 FileSystemManager.readFile 读取本地文件内容 支持 FileSystemManager.readFileSync FileSystemManager.readFile 的同步版本 支持 FileSystemManager.removeSavedFile 删除该小程序下已保存的本地缓存文件 支持 FileSystemManager.rename 重命名文件 支持 FileSystemManager.renameSync FileSystemManager.rename 的同步版本 支持 FileSystemManager.rmdir 删除目录 支持 FileSystemManager.rmdirSync FileSystemManager.rmdir 的同步版本 支持 FileSystemManager.saveFile 保存临时文件到本地 支持 FileSystemManager.saveFileSync FileSystemManager.saveFile 的同步版本 支持 FileSystemManager.stat 获取文件 Stats 对象 支持 FileSystemManager.statSync FileSystemManager.stat 的同步版本 支持 FileSystemManager.unlink 删除文件 支持 FileSystemManager.unlinkSync FileSystemManager.unlink 的同步版本 支持 FileSystemManager.unzip 解压文件 支持 FileSystemManager.writeFile 写文件 支持 FileSystemManager.writeFileSync FileSystemManager.writeFile 的同步版本 支持
Stats¶
API 说明 企业微信支持情况 Stats.isDirectory 判断当前文件是否一个目录 支持 Stats.isFile 判断当前文件是否一个普通文件 支持
开放接口¶
登录¶
API 说明 企业微信支持情况 wx.login 调用接口获取登录凭证（code） 支持 wx.checkSession 检查登录态是否过期 支持 code2Session 登录凭证校验 支持
小程序跳转¶
API 说明 企业微信支持情况 wx.navigateToMiniProgram 打开另一个小程序 支持 wx.navigateBackMiniProgram 返回到上一个小程序 支持
帐号信息¶
API 说明 企业微信支持情况 wx.getAccountInfoSync 获取当前帐号信息 不支持
用户信息¶
API 说明 企业微信支持情况 wx.getUserInfo 获取用户信息 支持 getPaidUnionId 用户支付完成后，获取该用户的 UnionId，无需用户授权 支持 UserInfo 用户信息 支持
接口调用凭证¶
API 说明 企业微信支持情况 getAccessToken 获取小程序全局唯一后台接口调用凭据（access_token） 支持
数据上报¶
API 说明 企业微信支持情况 wx.reportMonitor 自定义业务数据监控上报接口 不支持
数据分析¶
API 说明 企业微信支持情况 wx.reportAnalytics 自定义分析数据上报接口 不支持
访问留存¶
API 说明 企业微信支持情况 getAnalysisDailyRetain 获取用户访问小程序日留存 不支持 getAnalysisMonthlyRetain 获取用户访问小程序月留存 不支持 getAnalysisWeeklyRetain 获取用户访问小程序周留存 不支持 getAnalysisDailySummary 获取用户访问小程序数据概况 不支持
访问趋势¶
API 说明 企业微信支持情况 getAnalysisDailyVisitTrend 获取用户访问小程序数据日趋势 不支持 getAnalysisMonthlyVisitTrend 获取用户访问小程序数据月趋势 不支持 getAnalysisWeeklyVisitTrend 获取用户访问小程序数据周趋势 不支持 getAnalysisUserPortrait 获取小程序新增或活跃用户的画像分布数据 不支持 getAnalysisVisitDistribution 获取用户小程序访问分布数据 不支持 getAnalysisVisitPage 访问页面 不支持
支付¶
API 说明 企业微信支持情况 wx.requestPayment 发起微信支付 支持
授权¶
API 说明 企业微信支持情况 wx.authorize 提前向用户发起授权请求 支持
设置¶
API 说明 企业微信支持情况 wx.openSetting 调起客户端小程序设置界面，返回用户设置的操作结果 支持 wx.getSetting 获取用户的当前设置 支持 AuthSetting 用户授权设置信息，详情参考权限 支持
客服消息¶
API 说明 企业微信支持情况 customerTyping 下发客服当前输入状态给用户 不支持 getTempMedia 获取客服消息内的临时素材 不支持 sendCustomerMessage 发送客服消息给用户 不支持 uploadTempMedia 把媒体文件上传到微信服务器 不支持
模板消息¶
API 说明 企业微信支持情况 addTemplate 组合模板并添加至帐号下的个人模板库 不支持 deleteTemplate 删除帐号下的某个模板 不支持 getTemplateLibraryById 获取模板库某个模板标题下关键词库 不支持 getTemplateLibraryList 获取小程序模板库标题列表 不支持 getTemplateList 获取帐号下已存在的模板列表 不支持 sendTemplateMessage 发送模板消息 不支持
统一服务消息¶
API 说明 企业微信支持情况 sendUniformMessage 下发小程序和公众号统一的服务消息 支持
动态消息¶
API 说明 企业微信支持情况 createActivityId 创建被分享动态消息的 activity_id 不支持 setUpdatableMsg 修改被分享的动态消息 不支持
插件管理¶
API 说明 企业微信支持情况 applyPlugin 向插件开发者发起使用插件的申请 支持 getPluginDevApplyList 获取当前所有插件使用方（供插件开发者调用） 支持 getPluginList 查询已添加的插件 支持 setDevPluginApplyStatus 修改插件使用申请的状态（供插件开发者调用） 支持 unbindPlugin 删除已添加的插件 支持
收货地址¶
API 说明 企业微信支持情况 wx.chooseAddress 获取用户收货地址 支持
卡券¶
API 说明 企业微信支持情况 wx.openCard 查看微信卡包中的卡券 不支持 wx.addCard 批量添加卡券 不支持
发票¶
API 说明 企业微信支持情况 wx.chooseInvoiceTitle 选择用户的发票抬头 不支持 wx.chooseInvoice 选择用户已有的发票 不支持
附近的小程序¶
API 说明 企业微信支持情况 addNearbyPoi 添加地点 不支持 deleteNearbyPoi 删除地点 不支持 getNearbyPoiList 查看地点列表 不支持 setNearbyPoiShowStatus 展示/取消展示附近小程序 不支持
二维码¶
API 说明 企业微信支持情况 createWXAQRCode 获取小程序二维码，适用于需要的码数量较少的业务场景 支持 getWXACode 获取小程序码，适用于需要的码数量较少的业务场景 支持 getWXACodeUnlimit 获取小程序码，适用于需要的码数量极多的业务场景 支持
内容安全¶
API 说明 企业微信支持情况 imgSecCheck 校验一张图片是否含有违法违规内容 支持 msgSecCheck 检查一段文本是否含有违法违规内容 支持
生物认证¶
API 说明 企业微信支持情况 wx.startSoterAuthentication 开始 SOTER 生物认证 不支持 wx.checkIsSupportSoterAuthentication 获取本机支持的 SOTER 生物认证方式 不支持 wx.checkIsSoterEnrolledInDevice 获取设备内是否录入如指纹等生物信息的接口 不支持
微信运动¶
API 说明 企业微信支持情况 wx.getWeRunData 获取用户过去三十天微信运动步数 不支持
物流助手¶
小程序使用¶
API 说明 企业微信支持情况 addOrder 生成运单 支持 cancelOrder 取消运单 支持 getAllDelivery 获取支持的快递公司列表 支持 getOrder 获取运单数据 支持 getPath 查询运单轨迹 支持 getPrinter 获取打印员 支持 getQuota 获取电子面单余额 支持 onPathUpdate 运单轨迹更新事件 支持 updatePrinter 更新打印员 支持
服务提供方使用¶
API 说明 企业微信支持情况 getContact 获取面单联系人信息 支持 onAddOrder 请求下单事件 支持 onCancelOrder 取消订单事件 支持 onCheckBusiness 审核商户事件 支持 onGetQuota 查询商户余额事件 支持 previewTemplate 预览面单模板 支持 updateBusiness 更新商户审核结果 支持 updatePath 更新运单轨迹 支持
设备¶
iBeacon¶
API 说明 企业微信支持情况 wx.stopBeaconDiscovery 停止搜索附近的 iBeacon 设备 支持 wx.startBeaconDiscovery 开始搜索附近的 iBeacon 设备 支持 wx.onBeaconUpdate 监听 iBeacon 设备更新事件 支持 wx.onBeaconServiceChange 监听 iBeacon 服务状态变化事件 支持 wx.getBeacons 获取所有已搜索到的 iBeacon 设备 支持 IBeaconInfo 支持
Wi-Fi¶
API 说明 企业微信支持情况 wx.stopWifi 关闭 Wi-Fi 模块 支持 wx.startWifi 初始化 Wi-Fi 模块 支持 wx.setWifiList 设置 wifiList 中 AP 的相关信息 支持 wx.onWifiConnected 监听连接上 Wi-Fi 的事件 支持 wx.onGetWifiList 监听获取到 Wi-Fi 列表数据事件 支持 wx.getWifiList 请求获取 Wi-Fi 列表 支持 wx.getConnectedWifi 获取已连接中的 Wi-Fi 信息 支持 wx.connectWifi 连接 Wi-Fi 支持 WifiInfo Wifi 信息 支持
联系人¶
API 说明 企业微信支持情况 wx.addPhoneContact 添加手机通讯录联系人 支持
低功耗蓝牙¶
API 说明 企业微信支持情况 wx.writeBLECharacteristicValue 向低功耗蓝牙设备特征值中写入二进制数据 支持 wx.readBLECharacteristicValue 读取低功耗蓝牙设备的特征值的二进制数据值 支持 wx.onBLEConnectionStateChange 监听低功耗蓝牙连接状态的改变事件 支持 wx.onBLECharacteristicValueChange 监听低功耗蓝牙设备的特征值变化事件 支持 wx.notifyBLECharacteristicValueChange 启用低功耗蓝牙设备特征值变化时的 notify 功能，订阅特征值 支持 wx.getBLEDeviceServices 获取蓝牙设备所有服务(service) 支持 wx.getBLEDeviceCharacteristics 获取蓝牙设备某个服务中所有特征值(characteristic) 支持 wx.createBLEConnection 连接低功耗蓝牙设备 支持 wx.closeBLEConnection 断开与低功耗蓝牙设备的连接 支持
蓝牙¶
API 说明 企业微信支持情况 wx.stopBluetoothDevicesDiscovery 停止搜寻附近的蓝牙外围设备 支持 wx.startBluetoothDevicesDiscovery 开始搜寻附近的蓝牙外围设备 支持 wx.openBluetoothAdapter 初始化蓝牙模块 支持 wx.onBluetoothDeviceFound 监听寻找到新设备的事件 支持 wx.onBluetoothAdapterStateChange 监听蓝牙适配器状态变化事件 支持 wx.getConnectedBluetoothDevices 根据 uuid 获取处于已连接状态的设备 支持 wx.getBluetoothDevices 获取在蓝牙模块生效期间所有已发现的蓝牙设备 支持 wx.getBluetoothAdapterState 获取本机蓝牙适配器状态 支持 wx.closeBluetoothAdapter 关闭蓝牙模块 支持
电量¶
API 说明 企业微信支持情况 wx.getBatteryInfoSync wx.getBatteryInfo 的同步版本 支持 wx.getBatteryInfo 获取设备电量 支持
剪贴板¶
API 说明 企业微信支持情况 wx.setClipboardData 设置系统剪贴板的内容 支持 wx.getClipboardData 获取系统剪贴板的内容 支持
NFC¶
API 说明 企业微信支持情况 wx.stopHCE 关闭 NFC 模块 不支持 wx.startHCE 初始化 NFC 模块 不支持 wx.sendHCEMessage 发送 NFC 消息 不支持 wx.onHCEMessage 监听接收 NFC 设备消息事件 不支持 wx.getHCEState 判断当前设备是否支持 HCE 能力 不支持
网络¶
API 说明 企业微信支持情况 wx.onNetworkStatusChange 监听网络状态变化事件 支持 wx.getNetworkType 获取网络类型 支持
屏幕¶
API 说明 企业微信支持情况 wx.setScreenBrightness 设置屏幕亮度 支持 wx.setKeepScreenOn 设置是否保持常亮状态 支持 wx.onUserCaptureScreen 监听用户主动截屏事件 支持 wx.getScreenBrightness 获取屏幕亮度 支持
电话¶
API 说明 企业微信支持情况 wx.makePhoneCall 拨打电话 支持
加速计¶
API 说明 企业微信支持情况 wx.stopAccelerometer 停止监听加速度数据 支持 wx.startAccelerometer 开始监听加速度数据 支持 wx.onAccelerometerChange 监听加速度数据事件 支持
罗盘¶
API 说明 企业微信支持情况 wx.stopCompass 停止监听罗盘数据 支持 wx.startCompass 开始监听罗盘数据 支持 wx.onCompassChange 监听罗盘数据变化事件 支持
设备方向¶
API 说明 企业微信支持情况 wx.stopDeviceMotionListening 停止监听设备方向的变化 不支持 wx.startDeviceMotionListening 开始监听设备方向的变化 不支持 wx.onDeviceMotionChange 监听设备方向变化事件 不支持
陀螺仪¶
API 说明 企业微信支持情况 wx.stopGyroscope 停止监听陀螺仪数据 不支持 wx.startGyroscope 开始监听陀螺仪数据 不支持 wx.onGyroscopeChange 监听陀螺仪数据变化事件 不支持
性能¶
API 说明 企业微信支持情况 wx.onMemoryWarning 监听内存不足告警事件 支持
扫码¶
API 说明 企业微信支持情况 wx.scanCode 调起客户端扫码界面进行扫码 支持
振动¶
API 说明 企业微信支持情况 wx.vibrateShort 使手机发生较短时间的振动（15 ms） 支持 wx.vibrateLong 使手机发生较长时间的振动（400 ms) 支持
Worker¶
API 说明 企业微信支持情况 wx.createWorker 创建一个 [Worker 线程](https://developers.weixin.qq.com/miniprogram/dev/api/多线程 Worker.html) 支持
Worker¶
API 说明 企业微信支持情况 Worker.onMessage 监听主线程/Worker 线程向当前线程发送的消息的事件 支持 Worker.postMessage 向主线程/Worker 线程发送的消息 支持 Worker.terminate 结束当前 Worker 线程 支持
第三方平台¶
API 说明 企业微信支持情况 wx.getExtConfigSync wx.getExtConfig 的同步版本 不支持 wx.getExtConfig 获取第三方平台自定义的数据字段 不支持
WXML¶
API 说明 企业微信支持情况 wx.createSelectorQuery 返回一个 SelectorQuery 对象实例 支持 wx.createIntersectionObserver 创建并返回一个 IntersectionObserver 对象实例 支持
IntersectionObserver¶
API 说明 企业微信支持情况 IntersectionObserver.disconnect 停止监听 支持 IntersectionObserver.observe 指定目标节点并开始监听相交状态变化情况 支持 IntersectionObserver.relativeTo 使用选择器指定一个节点，作为参照区域之一 支持 IntersectionObserver.relativeToViewport 指定页面显示区域作为参照区域之一 支持
NodesRef¶
API 说明 企业微信支持情况 NodesRef.boundingClientRect 添加节点的布局位置的查询请求 支持 NodesRef.context 添加节点的 Context 对象查询请求 不支持 NodesRef.fields 获取节点的相关信息 支持 NodesRef.scrollOffset 添加节点的滚动位置查询请求 支持
SelectorQuery¶
API 说明 企业微信支持情况 SelectorQuery.exec 执行所有的请求 支持 SelectorQuery.in 将选择器的选取范围更改为自定义组件 component 内 支持 SelectorQuery.select 在当前页面下选择第一个匹配选择器 selector 的节点 支持 SelectorQuery.selectAll 在当前页面下选择匹配选择器 selector 的所有节点 支持 SelectorQuery.selectViewport 选择显示区域 支持