# 小程序 API 总览
# 开放接口
# 登录
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| login | 获取临时登录凭证 | 3.0.0 | 3.0.0 | 3.2.0 |
| checkSession | 检查用户当前的 session 状态是否有效 | 3.7.0 | 3.7.0 | 3.8.0 |
# 用户信息
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| enterProfile | 打开个人信息主页 | 3.3.0 | 3.3.0 | 3.4.0 |
| getUserInfo | 获取已登录用户的基本信息或特殊信息 | 3.6.0 | 3.6.0 | 3.8.0` |
# 聊天
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| enterChat | 打开指定会话 | 3.5.0 | 3.5.0 | 3.7.0 |
| toggleChat | 侧边栏形式打开或关闭会话 | X | X | 待开发 |
| chooseChat | 打开用户会话列表选择会话，调用前确保用户已经登入 | 3.3.0 | 3.3.0 | 3.4.0 |
| getChatInfo | 获取某个会话的信息 | 3.5.0 | 3.5.0 | 3.7.0 |
| getBlockActionSourceDetail | 支持从block action点击进入应用后，获取block对应业务的详细信息 | 待开发 | 待开发 | 待开发 |
| enterBot | 打开机器人聊天页面 | 3.5.0 | 3.5.0 | 3.7.0 |
| triggerCode | 用户从聊天工具栏点击打开应用时，生成一段随机数字，用以关联当前会话和应用，开发者可以通过triggercode直接以用户身份向会话中发信 | 3.5.0 | 3.5.0 | 3.6.0 |
| sendMessageCard | 发送消息卡片到指定会话 | 3.11.0 | 3.11.0 | 3.11.0 |
| sendTextMessage | 发送纯文本消息到指定会话 | 待开发 | 待开发 | 待开发 |
| onChatBadgeChange | 监听某个群未读消息数变化，确保用户已经登录 | 3.5.0 | 3.5.0 | 待开发 |
| offChatBadgeChange | 取消监听某个群未读消息数变化 | 3.5.0 | 3.5.0 | 待开发 |
# 联系人
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| chooseContact | 打开用户联系人选择列表 | 3.3.0 | 3.3.0 | 3.4.0 |
# 生物认证
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| faceVerify | 用户人脸验证，可以用来判断用户人脸图像和身份信息是否匹配 | 3.18.0 | 3.17.0 | X |
| startFaceIdentify | 用户有源人脸比对，可以用来判断用户人脸图像和身份信息是否匹配 | 待开发 | 待开发 | X |
| startFaceVerify | 用户人脸图像比对，可以用来判断两个人脸图像是否是同一个人 | 待开发 | 待开发 | X |
| startLocalFaceVerify | 本地无源比对接口 | 待开发 | 待开发 | X |
| checkLocalFaceVerify | 检测无源本地比对的可用性 | 待开发 | 待开发 | X |
| prepareLocalFaceVerify | 本地无源比对前置准备接口。此接口依赖网络，如果 check 接口返回失败，则需要先调用此接口进行 prepare，prepare 可能涉及网络下载， 需要一定时间才会返回，接入方可指定超时时间 | 待开发 | 待开发 | X |
# 设置
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| openSetting | 打开设置页面，展示用户设置（包括授予和拒绝）过的权限，并返回用户设置过的授权结果 | 待开发 | 待开发 | 待开发 |
| getSetting | 获取用户设置（包括授予和拒绝）过的权限 | 待开发 | 待开发 | 待开发 |
# 分享
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| share | 分享内容到三方应用 | 3.7.0 | 3.7.0 | X |
# 授权
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| authorize | 向用户发出设置权限请求。如果该权限用户没有设置过，会弹窗咨询用户是否授予；如果该权限用户拒绝授予，会打开设置页面(appBadge权限除外)； 如果该权限用户同意授予，会直接返回成功 | 待开发 | 待开发 | 待开发 |
# BossHi启动参数
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getLaunchOptionsSync | 获取小程序启动时的参数 | 3.6.0 | 3.6.0 | 3.6.0 |
# 安全密码验证
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| startPasswordVerify | 调起二次验证BossHi安全密码的输入界面 | 待开发 | 待开发 | 待开发 |
# 系统认证
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| startDeviceCredential | 打开系统解锁界面 | 待开发 | 待开发 | X |
# 水印
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| checkWatermark | 查看宿主是否显示了全局水印 | 待开发 | 待开发 | 待开发 |
# 邮件
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| mailto | 调用系统发送邮件 | 待开发 | 待开发 | 待开发 |
# 界面
# 交互反馈
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| showActionSheet | 显示操作菜单 | 3.2.0 | 3.2.0 | 3.2.0 |
| showModal | 显示模态弹窗 | 3.1.0 | 3.1.0 | 3.2.0 |
| showPrompt | 展示可输入内容的弹窗 | 3.2.0 | 3.2.0 | 3.2.0 |
| showLoading | 显示灰色背景的 loading 提示框 | 3.1.0 | 3.1.0 | 3.2.0 |
| hideLoading | 隐藏 loading 提示框 | 3.1.0 | 3.1.0 | 3.2.0 |
| showToast | 显示灰色背景的消息提示框 | 3.1.0 | 3.1.0 | 3.2.0 |
| hideToast | 隐藏灰色背景的消息提示框 | 3.1.0 | 3.1.0 | 3.2.0 |
# Tab Bar
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| showTabBar | 显示 tabBar | 3.0.0 | 3.0.0 | 3.5.0 |
| hideTabBar | 隐藏 tabBar | 3.0.0 | 3.0.0 | 3.5.0 |
| setTabBarItem | 动态设置 tabBar 某一项的内容 | 3.0.0 | 3.0.0 | 3.5.0 |
| addTabBarItem | 当前小程序的tab bar数量进行增加调整 | 待开发 | 待开发 | 待开发 |
| removeTabBarItem | 删除tab bar的目标item | 待开发 | 待开发 | 待开发 |
| setTabBarStyle | 动态设置 tabBar 的整体样式 | 3.0.0 | 3.0.0 | 3.5.0 |
| setTabBarBadge | 为 tabBar 某一项的右上角添加文本 | 3.0.0 | 3.0.0 | 3.5.0 |
| removeTabBarBadge | 移除 tabBar 某一项右上角的文本 | 3.0.0 | 3.0.0 | 3.5.0 |
| showTabBarRedDot | 显示 tabBar 某一项的右上角的红点，可以使用底部标签栏红点给予用户提示 | 3.0.0 | 3.0.0 | 3.5.0 |
| hideTabBarRedDot | 隐藏 tabBar 某一项的右上角的红点 | 3.0.0 | 3.0.0 | 3.5.0 |
# 导航栏
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setNavigationBarTitle | 设置导航栏标题 | 3.0.0 | 3.0.0 | 3.2.0 |
# 窗口
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setWindowSize | 小程序在 window 和 window-semi 模式下调整独立窗口的大小和位置 | X | X | 待开发 |
| onWindowResize | 监听窗口尺寸变化事件 | 待开发 | 待开发 | 待开发 |
| offWindowResize | 取消监听窗口尺寸变化事件 | 待开发 | 待开发 | 待开发 |
# 下拉刷新
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| Page.onPullDownRefresh | 在 Page 中注册下拉刷新的监听方法，当用户触发下拉刷新时会调用 | 3.0.0 | 3.0.0 | X |
| startPullDownRefresh | 下拉刷新 | 3.0.0 | 3.0.0 | X |
| stopPullDownRefresh | 停止当前页面下拉刷新 | 3.0.0 | 3.0.0 | X |
# 页面离开二次确认
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| enableLeaveConfirm | 当某个页面返回或关闭时设置二次弹窗提示 | 3.6.0 | 3.6.0 | 3.8.0 |
| disableLeaveConfirm | 取消当前页面离开二次确认弹框 | 3.6.0 | 3.6.0 | 3.8.0 |
# 页面位置
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| pageScrollTo | 滚动页面到目标位置 | 3.0.0 | 3.0.0 | 3.2.0 |
# Canvas绘图
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| createCanvasContext | 创建并返回对应 canvasId 的绘图上下文 | 3.0.0 | 3.0.0 | 3.2.0 |
| canvasToTempFilePath | 导出当前画布指定区域，生成图片并返回文件路径 | 3.0.0 | 3.0.0 | 3.2.0 |
| canvasPutImageData | 更新画布像素数据 | 3.0.0 | 3.0.0 | 3.2.0 |
| canvasGetImageData | 获取画布像素数据 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.createPattern | 创建径向渐变管理对象 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.createCircularGradient | 创建圆形渐变管理对象 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.translate | 平移坐标矩阵 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.transform | 坐标转换矩阵叠加，每一次调用会在乘以前一次的变换矩阵 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.strokeText | 绘制文字路径 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.strokeRect | 绘制矩形路径，不添加到当前路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.stroke | 绘制当前路径 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setTransform | 设置坐标转换矩阵 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setTextBaseline | 设置字体的对齐基线 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setTextAlign | 设置字体对齐方式 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setStrokeStyle | 设置绘制线样式 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setShadow | 设置阴影 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setMiterLimit | 设置线连接点渲染的斜面倾斜程度 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setLineWidth | 设置线宽 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setLineJoin | 设置线连接点样式 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setLineDash | 设置间断线 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setLineCap | 设置线端点样式 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setGlobalAlpha | 设置全局不透明度 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.setFillStyle | 设置填充样式 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.scale | 缩放坐标点 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.save | 创建新的绘图上下文，并将之前的上下文保存在栈中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.rotate | 旋转坐标点 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.restore | 恢复栈中存储的上下文 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.rect | 添加矩形到当前路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.quadraticCurveTo | 添加二次贝塞尔曲线到路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.moveTo | 移动绘制点 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.measureText | 测量文字宽度 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.lineTo | 移动并添加线段到路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.fillText | 填充文字 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.fillRect | 填充矩形，不添加到当前路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.fill | 填充当前路径 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.drawImage | 绘制 Image | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.createLinearGradient | 创建线性渐变对象 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.closePath | 闭合当前路径 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.clip | 剪切当前路径，限制后续的渲染范围 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.clearRect | 清空画布矩形区域 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.bezierCurveTo | 添加三次贝塞尔曲线到路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.beginPath | 创建新的子路径 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.arcTo | 移动并添加弧线到当前路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.arc | 添加圆弧到当前路径中 | 3.0.0 | 3.0.0 | 3.2.0 |
| CanvasContext.draw | 将所有的操作绘制到 Canvas 中 | 3.0.0 | 3.0.0 | 3.2.0 |
# 动画
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| createAnimation | 创建一个动画实例 animation。调用实例的方法来描述动画。 最后通过动画实例的 export 方法导出动画数据传递给组件的 animation 属性 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.backgroundColor | 设置背景色 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.bottom | 设置 bottom 值 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.export | 导出动画队列。export 方法每次调用后会清掉之前的动画操作 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.height | 设置高度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.left | 设置 left 值 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.matrix | 同 transform-function matrix | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.matrix3d | 同 transform-function matrix3d | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.opacity | 设置透明度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.right | 设置 right 值 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.rotate | 从原点顺时针旋转一个角度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.rotate3d | 从 固定 轴顺时针旋转一个角度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.rotateX | 从 X 轴顺时针旋转一个角度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.rotateY | 从 Y 轴顺时针旋转一个角度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.rotateZ | 从 Z 轴顺时针旋转一个角度 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.scale | 缩放 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.scale3d | 缩放 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.scaleX | 缩放 X 轴 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.scaleY | 缩放 Y 轴 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.scaleZ | 缩放 Z 轴 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.skew | 对 X、Y 轴坐标进行倾斜 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.skewX | 对 X 轴坐标进行倾斜 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.skewY | 对 Y 轴坐标进行倾斜 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.step | 表示一组动画完成。可以在一组动画中调用任意多个动画方法，一组动画中的所有动画会同时开始， 一组动画完成后才会进行下一组动画 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.top | 设置 top 值 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.translate | 平移变换 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.translate3d | 对 xyz 坐标进行平移变换 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.translateX | 对 X 轴平移 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.translateY | 对 Y 轴平移 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.translateZ | 对 Z 轴平移 | 3.0.0 | 3.0.0 | 3.2.0 |
| Animation.width | 设置宽度 | 3.0.0 | 3.0.0 | 3.2.0 |
# Customized Input
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getCustomizedInput | 获取全局唯一的customizedInput实例。通过customizedInput显示一个 可定制化的富文本输入框， 支持@联系人、插入图片、插入表情、显示用户头像、切换用户头像状态 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.show | 显示输入框 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.update | 更新输入框中显示的内容 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.hide | 隐藏输入框 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.onPicSelect | 监听连接成功的事件回调 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.onModelSelect | 选择pickerView之后触发的事件 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.onPublish | 点击发送按钮触发的事件 | 待开发 | 待开发 | 待开发 |
| CustomizedInput.onHide | 隐藏输入框之后触发的事件 | 待开发 | 待开发 | 待开发 |
# Pad
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| togglePadFullScreen | 在当前Pad小程序窗口可以全屏缩放的前提下， 进行全屏缩放状态的切换 | 待开发 | 待开发 | X |
| getPadDisplayScaleMode | 获取当前Pad的小程序窗口缩放状态，当前显示状态 能否进行全屏缩放的切换 | 待开发 | 待开发 | X |
# 设备
# 系统信息
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getSystemInfo | 获取系统信息 | 3.1.0 | 3.1.0 | 3.2.0 |
| getSystemInfoSync | 获取系统信息 | 3.1.0 | 3.1.0 | 3.2.0 |
# NFC
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getNFCAdapter | 获取 NFC 实例 | 待开发 | X | X |
| NFCAdapter.getNfcA | 获取NfcA实例，实例支持NFC-A (ISO 14443-3A)标准的读写 | 待开发 | X | X |
| NFCAdapter.getMifareClassic | 获取MifareClassic实例，实例支持MIFARE Classic标签的读写 | 待开发 | X | X |
| NFCAdapter.startDiscovery | 开始扫描NFC标签 | 待开发 | X | X |
| NFCAdapter.stopDiscovery | 关闭NFC标签扫描 | 待开发 | X | X |
| NFCAdapter.onDiscovered | 监听 NFC Tag | 待开发 | X | X |
| NFCAdapter.offDiscovered | 取消监听 NFC Tag | 待开发 | X | X |
| NfcA.connect | 连接NfcA类型的标签 | 待开发 | X | X |
| NfcA.transceive | 发送数据给NFCA类型的标签 | 待开发 | X | X |
| NfcA.close | 断开与NFCA标签之间的连接 | 待开发 | X | X |
| NfcA.getAtqa | 获取ATQA信息 | 待开发 | X | X |
| NfcA.getMaxTransceiveLength | 获取最大传输长度 | 待开发 | X | X |
| NfcA.getSak | 获取SAK信息 | 待开发 | X | X |
| NfcA.setTimeout | 设置超时时间 | 待开发 | X | X |
| MifareClassic.connect | 连接MifareClassic类型的标签 | 待开发 | X | X |
| MifareClassic.transceive | 发送数据给MifareClassic类型的标签 | 待开发 | X | X |
| MifareClassic.close | 断开与MifareClassic标签之间的连接 | 待开发 | X | X |
| MifareClassic.getMaxTransceiveLength | 获取最大传输长度 | 待开发 | X | X |
| MifareClassic.setTimeout | 设置超时时间 | 待开发 | X | X |
# 蓝牙
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| openBluetoothAdapter | 初始化蓝牙模块 | 待开发 | 待开发 | X |
| closeBluetoothAdapter | 关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后， 与 bz.openBluetoothAdapter 成对调用 | 待开发 | 待开发 | X |
| getBluetoothAdapterState | 获取本机蓝牙适配器状态 | 待开发 | 待开发 | X |
| startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备 | 待开发 | 待开发 | X |
| stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时，建议调用该接口停止蓝牙搜索 | 待开发 | 待开发 | X |
| getConnectedBluetoothDevices | 根据 uuid 获取处于已连接状态的设备 | 待开发 | 待开发 | X |
| getBluetoothDevices | 获取在蓝牙模块生效期间所有已发现的蓝牙设备。包括已经和本机处于连接状态的设备 | 待开发 | 待开发 | X |
| onBluetoothDeviceFound | 监听寻找到新设备的事件 | 待开发 | 待开发 | X |
| offBluetoothDeviceFound | 取消监听寻找到新设备的事件 | 待开发 | 待开发 | X |
| onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化事件 | 待开发 | 待开发 | X |
| offBluetoothAdapterStateChange | 取消监听蓝牙适配器状态变化事件 | 待开发 | 待开发 | X |
# 扫码
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| scanCode | 扫描二维码并返回扫描结果 | 3.5.0 | 3.5.0 | X |
# Wi-Fi
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getConnectedWifi | 获取设备当前所连的 Wifi | 3.5.0 | 3.5.0 | X |
| getWifiStatus | 请求获取 Wi-Fi 开关状态 | 3.5.0 | 3.5.0 | X |
| getWifiList | 请求获取Wifi 列表 | 3.5.0 | X | X |
| onGetWifiList | 监听获取到 Wi-Fi 列表数据事件 | 3.5.0 | X | X |
| offGetWifiList | 取消监听获取到 Wi-Fi 列表数据事件 | 3.5.0 | X | X |
| connectWifi | 连接Wi-Fi | 3.0.0 | 3.0.0 | X |
# 剪贴板
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setClipboardData | 设置系统剪贴板内容 | 3.5.0 | 3.5.0 | 3.5.0 |
| getClipboardData | 获取系统粘贴板数据 | 3.5.0 | 3.5.0 | 3.5.0 |
| setClipboardEvent | 文字选中时，打开/关闭复制等原生按钮的展示 | 待开发 | 待开发 | 待开发 |
# 网络状态
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getNetworkType | 获取设备当前所处的网络类型 | 3.5.0 | 3.5.0 | 3.8.0 |
| onNetworkStatusChange | 监听网络状态变化 | 3.5.0 | 3.5.0 | 3.8.0 |
| offNetworkStatusChange | 取消监听网络状态变化 | 3.5.0 | 3.5.0 | 3.8.0 |
| getNetworkQualityType | 网络评级接口，获取当前设备所处的网络状态 | 3.5.0 | 3.5.0 | 3.8.0 |
| onNetworkQualityChange | 监听网络质量变化 | 3.5.0 | 3.5.0 | 3.8.0 |
| offNetworkQualityChange | 取消监听网络质量变化 | 3.5.0 | 3.5.0 | 3.8.0 |
# 屏幕亮度
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setScreenBrightness | 设置屏幕亮度 | 3.6.0 | 3.6.0 | X |
| getScreenBrightness | 获取屏幕亮度 | 3.6.0 | 3.6.0 | X |
| setKeepScreenOn | 设置是否保持常亮状态 | 3.6.0 | 3.6.0 | X |
# 截屏监听
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| onUserCaptureScreen | 监听用户主动截屏事件。用户使用系统截屏按键截屏时触发 | 3.6.0 | 3.6.0 | X |
| offUserCaptureScreen | 取消监听用户主动截屏事件 | 3.6.0 | 3.6.0 | X |
# 加速度计
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| startAccelerometer | 通知客户端开始监听加速度计数据。具体的数据返回通过注册onAccelerometerChange接口回调方法获取 | 3.6.0 | 3.6.0 | X |
| stopAccelerometer | 停止监听加速度计数据 | 3.6.0 | 3.6.0 | X |
| onAccelerometerChange | 监听加速度计数据 | 3.6.0 | 3.6.0 | X |
# 拨打电话
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| makePhoneCall | 拨打电话 | 3.6.0 | 3.6.0 | X |
# 震动
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| vibrateShort | 使手机发生较短时间的振动 | 3.6.0 | 3.6.0 | X |
| vibrateLong | 使手机发生较长时间的振动 | 3.6.0 | 3.6.0 | X |
# 罗盘
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| startCompass | 开始监听罗盘数据。 | 3.6.0 | 3.6.0 | X |
| stopCompass | 停止监听罗盘数据 | 3.6.0 | 3.6.0 | X |
| onCompassChange | 监听罗盘数据变化事件，频率：5 次/秒，接口调用后会自动开始监听，可使用 bz.stopCompass 停止监听 | 3.6.0 | 3.6.0 | X |
# 文件
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| previewFile | 预览文件 | 3.3.0 | 3.3.0 | 3.4.0 |
| saveFile | 保存临时文件到本地永久目录 | 待开发 | 待开发 | 待开发 |
| saveFileAs | 保存文件到本地指定目录 | X | X | 待开发 |
| filePicker | 打开附件选择列表 | 3.3.0 | 3.3.0 | 3.4.0 |
| docsPicker | 打开云文档选择列表 | 待开发 | 待开发 | 待开发 |
| openDocument | 在新页面打开文档 | 待开发 | 待开发 | 待开发 |
| getFileSystemManager | 获取全局唯一的文件管理器 | 3.12.0 | 3.9.0 | 3.10.0 |
| FileSystemManager.readFile | 读取本地文件内容 | 3.12.0 | 3.11.0 | 3.10.0 |
| FileSystemManager.stat | 获取本地文件 Stats 对象 | 3.12.0 | 3.11.0 | 3.10.0 |
| Stats.isDirectory | 判断当前文件是否一个目录 | 3.12.0 | 3.11.0 | 3.10.0 |
| Stats.isFile | 判断当前文件是否一个普通文件 | 3.12.0 | 3.11.0 | 3.10.0 |
# 媒体
# 图片
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| saveImageToPhotosAlbum | 保存图片到系统相册 | 3.6.0 | 3.6.0 | 待开发 |
| chooseImage | 从系统相册中选择图片，或使用相机拍摄图片 | 3.3.0 | 3.3.0 | 3.4.0 |
| previewImage | 预览一组图片 | 3.3.0 | 3.3.0 | 3.4.0 |
| compressImage | 压缩图片接口，可选压缩质量 | 3.6.0 | 3.6.0 | 待开发 |
| getImageInfo | 获取图片信息 | 3.6.0 | 3.6.0 | 3.8.0 |
# 视频
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| saveVideoToPhotosAlbum | 保存视频到系统相册 | 3.7.0 | 3.7.0 | 待开发 |
| chooseVideo | 从系统相册中选择视频，或使用相机拍摄视频 | 3.7.0 | 3.7.0 | 3.8.0 |
| chooseMedia | 拍摄或从系统相册中选择图片或视频 | 3.7.0 | 3.7.0 | 3.8.0 |
| createVideoContext | 创建 VideoContext 实例，通过 id 跟一个 video 组件绑定，操作对应的 video 组件 | 待开发 | 待开发 | 待开发 |
| VideoContext.play | 播放视频 | 待开发 | 待开发 | 待开发 |
| VideoContext.pause | 暂停视频 | 待开发 | 待开发 | 待开发 |
| VideoContext.stop | 停止视频 | 待开发 | 待开发 | 待开发 |
| VideoContext.seek | 跳转到指定位置 | 待开发 | 待开发 | 待开发 |
| VideoContext.requestFullScreen | 进入全屏 | 待开发 | 待开发 | 待开发 |
| VideoContext.exitFullScreen | 退出全屏 | 待开发 | 待开发 | 待开发 |
# 音频
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| createInnerAudioContext | 创建innerAudioContext实例，通过它能够操作音频播放 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.play | 播放音频 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.pause | 暂停。暂停后的音频再播放会从暂停处开始播放 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.stop | 停止。停止后的音频再播放会从头开始播放 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.seek | 跳转到指定位置 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.destroy | 销毁当前实例 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onCanplay | 音频进入可以播放状态时触发回调函数 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offCanplay | 取消监听 Canplay 事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onPlay | 监听音频播放事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offPlay | 取消监听音频播放事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onPause | 监听音频暂停事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offPause | 取消监听音频暂停事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onStop | 监听音频停止事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offStop | 取消监听音频停止事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onEnded | 监听音频自然播放至结束的事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offEnded | 取消监听音频自然播放至结束的事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onTimeUpdate | 监听音频播放进度更新事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offTimeUpdate | 取消监听音频播放进度更新事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onError | 监听音频播放错误事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offError | 取消监听音频播放错误事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onWaiting | 监听音频加载中事件。当音频因为数据不足，需要停下来加载时会触发 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offWaiting | 取消监听音频加载中事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onSeeking | 监听音频进行跳转操作的事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offSeeking | 取消监听音频进行跳转操作的事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.onSeeked | 监听音频完成跳转操作的事件 | 3.9.0 | 3.8.0 | X |
| InnerAudioContext.offSeeked | 取消监听音频完成跳转操作的事件 | 3.9.0 | 3.8.0 | X |
# 录音
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getRecorderManager | 获取全局唯一的recorderManager。通过recorderManager进行录音操作和管理 | 3.9.0 | 3.7.0 | X |
| RecorderManager.start | 开始录音 | 3.9.0 | 3.7.0 | X |
| RecorderManager.pause | 暂停录音 | 3.9.0 | 3.7.0 | X |
| RecorderManager.resume | 继续录音 | 3.9.0 | 3.7.0 | X |
| RecorderManager.stop | 停止录音 | 3.9.0 | 3.7.0 | X |
| RecorderManager.onStart | 监听录音开始事件 | 3.9.0 | 3.7.0 | X |
| RecorderManager.onPause | 监听录音暂停事件 | 3.9.0 | 3.7.0 | X |
| RecorderManager.onResume | 监听录音继续事件 | 3.9.0 | 3.7.0 | X |
| RecorderManager.onStop | 监听录音结束事件 | 3.9.0 | 3.7.0 | X |
| RecorderManager.onFrameRecorded | 监听已录制完指定帧大小的文件事件。如果设置了 frameSize，则会回调此事件 | 3.9.0 | 3.7.0 | X |
| RecorderManager.onError | 监听录音错误事件 | 3.9.0 | 3.7.0 | X |
# 导航
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| onNavigateBack | 监听点击页面返回的事件 | 3.9.0 | 3.8.0 | 3.8.0 |
| navigateTo | 跳转到指定页面。跳转后原页面保留 | 3.0.0 | 3.0.0 | 3.2.0 |
| navigateBack | 返回上一级页面（或上N级页面）。可通过 getCurrentPages 获取当前的页面栈，决定需要返回几层 | 3.0.0 | 3.0.0 | 3.2.0 |
| redirectTo | 关闭当前页面，跳转到指定页面 | 3.0.0 | 3.0.0 | 3.2.0 |
| switchTab | 跳转到指定 TabBar 页面，并关闭其他所有非 TabBar 页面 | 3.0.0 | 3.0.0 | 3.2.0 |
| reLaunch | 关闭所有当前页面，打开指定页面 | 3.0.0 | 3.0.0 | 3.2.0 |
| exitMiniProgram | 退出当前小程序 | 3.0.0 | 3.0.0 | 3.2.0 |
| openSchema | 跳转到小程序以外的应用（如云文档、网页等） | 3.6.0 | 3.6.0 | 3.8.0 |
# 网络
# WebSocket
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| connectSocket | 创建一个 WebSocket 连接实例，并通过返回的 socketTask 操作该连接 | 3.19.0 | 3.19.0 | 3.21.0 |
| SocketTask.send | 通过 WebSocket 连接发送数据 | 3.19.0 | 3.19.0 | 3.21.0 |
| SocketTask.close | 关闭 WebSocket 连接 | 3.19.0 | 3.19.0 | 3.21.0 |
| SocketTask.onOpen | 监听 WebSocket 连接打开事件 | 3.19.0 | 3.19.0 | 3.21.0 |
| SocketTask.onClose | 监听 WebSocket 连接关闭事件 | 3.19.0 | 3.19.0 | 3.21.0 |
| SocketTask.onMessage | 监听 WebSocket 接受到服务器的消息事件 | 3.19.0 | 3.19.0 | 3.21.0 |
# HTTP
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| request | 发起一个 HTTP 请求 | 3.1.0 | 3.1.0 | 3.2.0 |
| RequestTask.abort | 中断请求任务 | 3.1.0 | 3.1.0 | 3.2.0 |
| downloadFile | 下载网络文件到本地临时目录 | 3.3.0 | 3.3.0 | 3.4.0 |
| DownloadTask.onProgressUpdate | downloadFile的调用结果在通过回调传递的同时会返回一个downloadTask对象， 通过onProgressUpdate方法监听下载进度 | 3.3.0 | 3.3.0 | 3.4.0 |
| DownloadTask.offProgressUpdate | downloadFile的调用结果在通过回调传递的同时会返回一个downloadTask对象， 可以通过该对象的offProgressUpdate方法取消监听下载。 | 3.3.0 | 3.3.0 | 3.4.0 |
| DownloadTask.abort | 调用downloadFile时，会返回一个downloadTask对象，可以通过该对象的abort方法中断请求任务 | 3.3.0 | 3.3.0 | 3.4.0 |
| uploadFile | 将本地文件上传到网络 | 3.3.0 | 3.3.0 | 3.4.0 |
| UploadTask.onProgressUpdate | 调用uploadFile时，会返回一个uploadTask对象，通过onProgressUpdate方法监听下载进度 | 3.3.0 | 3.3.0 | 3.4.0 |
| UploadTask.offProgressUpdate | upoadFile的调用结果在通过回调传递的同时会返回一个uploadTask对象， 可以通过该对象的offProgressUpdate方法取消监听下载。 | 3.3.0 | 3.3.0 | 3.4.0 |
| UploadTask.abort | 调用uploadFile时，会返回一个uploadTask对象，可以通过该对象的abort方法中断请求任务 | 3.3.0 | 3.3.0 | 3.4.0 |
# 地理位置
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| openLocation | 使用客户端内置地图查看位置 | 待开发 | 待开发 | X |
| chooseLocation | 打开地图选择位置 | 待开发 | 待开发 | X |
| getLocation | 获取设备当前的地理位置 | 3.0.0 | 3.0.0 | X |
| startLocationUpdate | 开启小程序在前台时接收位置更新消息 | 待开发 | 待开发 | X |
| stopLocationUpdate | 关闭监听实时位置变化，停止位置消息接收 | 待开发 | 待开发 | X |
| onLocationChange | 监听实时地理位置变化事件，需结合startLocationUpdate使用 | 待开发 | 待开发 | X |
| offLocationChange | 取消监听实时地理位置变化事件 | 待开发 | 待开发 | X |
# 数据缓存
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setStorage | 以「键值对」的形式设置本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| setStorageSync | 以「键值对」的形式设置本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| getStorage | 获取本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| getStorageSync | 获取本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| removeStorage | 删除本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| removeStorageSync | 删除本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| clearStorage | 清理全部本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| clearStorageSync | 清理全部本地缓存数据 | 3.2.0 | 3.2.0 | 3.2.0 |
| getStorageInfo | 获取本地缓存数据的相关信息 | 3.2.0 | 3.2.0 | 3.2.0 |
| getStorageInfoSync | 获取本地缓存数据的相关信息 | 3.2.0 | 3.2.0 | 3.2.0 |
# BZML
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| createSelectorQuery | 获取一个 SelectorQuery 对象实例 | 3.0.0 | 3.0.0 | 3.2.0 |
| SelectorQuery.in | 将选择器的选取范围更改为自定义组件 component 内（初始时，选择器仅选取页面范围的节点， 不会选取任何自定义组件中的节点） | 3.0.0 | 3.0.0 | 3.2.0 |
| SelectorQuery.select | 在当前页面下选择第一个匹配选择器 selector 的节点，返回一个 NodesRef 对象实例，可以用于获取节点信息。 selector 类似于 CSS 的选择器，其中移动端只支持 ID 选择器 | 3.0.0 | 3.0.0 | 3.2.0 |
| SelectorQuery.selectAll | 在当前页面下选择匹配选择器 selector 的所有节点，返回一个 NodesRef 对象实例，可以用于获取节点信息。 selector 类似于 CSS 的选择器，同 select | 3.0.0 | 3.0.0 | 3.2.0 |
| SelectorQuery.selectViewport | 选择显示区域。可用于获取显示区域的尺寸、滚动位置等信息 | 3.0.0 | 3.0.0 | X |
| SelectorQuery.exec | 执行所有的请求。请求结果按请求次序构成数组，在callback的第一个参数中返回 | 3.0.0 | 3.0.0 | 3.2.0 |
| NodesRef.boundingClientRect | 添加节点的布局位置的查询请求 | 3.0.0 | 3.0.0 | 3.2.0 |
| NodesRef.scrollOffset | 添加节点的滚动位置查询请求 | 3.0.0 | 3.0.0 | 3.2.0 |
| NodesRef.fields | 获取节点的相关信息 | 3.0.0 | 3.0.0 | 3.2.0 |
| createIntersectionObserver | 创建并返回一个 IntersectionObserver 对象实例 | 3.0.0 | 3.0.0 | 3.2.0 |
| IntersectionObserver.observe | 指定目标节点并开始监听相交状态变化情况 | 3.0.0 | 3.0.0 | 3.2.0 |
| IntersectionObserver.relativeTo | 使用选择器指定一个节点，作为参照区域之一 | 3.0.0 | 3.0.0 | 3.2.0 |
| IntersectionObserver.relativeToViewport | 指定页面显示区域作为参照区域之一 | 3.0.0 | 3.0.0 | 3.2.0 |
| IntersectionObserver.disconnect | 停止监听，回调函数将不再触发 | 3.0.0 | 3.0.0 | 3.2.0 |
# 转发
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| showShareMenu | 显示当前页面的分享按钮 | 3.7.0 | 3.7.0 | 3.10.0 |
| hideShareMenu | 隐藏当前页面的分享按钮 | 3.7.0 | 3.7.0 | 3.10.0 |
# 更新
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getUpdateManager | 获取全局唯一的版本更新管理器，返回 updateManager 对象，用于管理小程序更新 | 3.12.0 | 3.12.0 | 3.12.0 |
| UpdateManager.applyUpdate | 强制小程序重启并使用新版本。在小程序新版本下载完成后（即收到 onUpdateReady 回调）调用 | 3.12.0 | 3.12.0 | 3.12.0 |
| UpdateManager.onCheckForUpdate | 监听向后台请求检查更新结果事件。客户端在小程序冷启动时自动检查更新，不需由开发者主动触发。 线上环境在有更新内容时会触发callback回调 | 3.12.0 | 3.12.0 | 3.12.0 |
| UpdateManager.onUpdateFailed | 监听小程序更新失败事件 | 3.12.0 | 3.12.0 | 3.12.0 |
| UpdateManager.onUpdateReady | 监听小程序有版本更新事件 | 3.12.0 | 3.12.0 | 3.12.0 |
| UpdateManager.triggerCheckUpdate | 主动触发更新小程序 | 3.12.0 | 3.12.0 | 3.12.0 |