# JSAPI 总览
提示
requestAuthCode、closeWindow API 无需网页应用鉴权即可使用；
其他 JSAPI 均需要 网页应用鉴权 后才能使用
# 开放接口
# 基础能力
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| config | 调用config 接口进行 鉴权，JSAPI使用的必须前置条件 | 3.3.0 | 3.3.0 | 3.9.0 |
| ready | 所有JSAPI都必须在ready触发后调用（后续调用不用在重复执行ready） | 3.3.0 | 3.3.0 | 3.9.0 |
| error | config鉴权失败后会执行fail方法 | 3.3.0 | 3.3.0 | 3.9.0 |
# 登录
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| requestAuthCode | 获取网页应用免登授权码，便于网页应用中实现用户免登流程 | 3.2.0 | 3.2.0 | 3.2.0 |
# 用户信息
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| enterProfile | 进入个人信息主页 | 3.11.0 | 3.11.0 | 3.11.0 |
| getUserInfo | 获取已登录用户的基本信息或特殊信息 | 3.19.0 | 3.19.0 | 3.19.0 |
# 聊天
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| enterChat | 打开指定会话 | 3.17.0 | 3.17.0 | 3.15.1 |
| toggleChat | 侧边栏形式打开或关闭会话 | X | X | 待开发 |
| chooseChat | 打开用户会话列表选择会话，调用前确保用户已经登入 | 3.11.0 | 3.11.0 | 3.11.0 |
| getChatInfo | 获取某个会话的信息 | 待开发 | 待开发 | 待开发 |
| sendMessageCard | 发送消息卡片到指定会话 | 3.11.0 | 3.11.0 | 3.11.0 |
| sendTextMessage | 发送纯文本消息到指定会话 | 3.16.0 | 3.16.0 | X |
# 联系人
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| chooseContact | 支持打开用户联系人选择列表，可以选择BossHi用户或部门，并获取选中用户或部门的信息 | 3.19.0 | 3.19.0 | 3.19.0 |
# 生物认证
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| faceVerify | 用户人脸验证，可以用来判断用户人脸图像和身份信息是否匹配 | 3.17.0 | 3.17.0 | X |
# 设置
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| openSetting | 打开设置页面，展示用户设置（包括授予和拒绝）过的权限，并返回用户设置过的授权结果 | 待开发 | 待开发 | 待开发 |
| getSetting | 获取用户设置（包括授予和拒绝）过的权限 | 待开发 | 待开发 | 待开发 |
# 分享
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| share | 分享内容到三方应用 | 待开发 | 待开发 | 待开发 |
# 授权
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| authorize | 向用户发出设置权限请求。如果该权限用户没有设置过，会弹窗咨询用户是否授予；如果该权限用户拒绝授予，会打开设置页面(appBadge权限除外)；如果该权限用户同意授予，会直接返回成功 | 待开发 | 待开发 | 待开发 |
# 安全密码验证
| 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.3.0 | 3.3.0 | 待开发 |
| showModal | 显示模态弹窗 | 3.3.0 | 3.3.0 | 待开发 |
| showPrompt | 展示可输入内容的弹窗 | 3.3.0 | 3.3.0 | 待开发 |
| showToast | 显示灰色背景的消息提示框 | 3.3.0 | 3.3.0 | 待开发 |
| hideToast | 隐藏灰色背景的消息提示框 | 3.3.0 | 3.3.0 | 待开发 |
# 导航栏
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setNavigationBar | 自定义导航栏左侧和右侧的按钮（如“返回”、“确定”） | 待开发 | 待开发 | 待开发 |
| onLeftNavigationBarClick | 监听导航栏左侧点击事件 | 待开发 | 待开发 | 待开发 |
| onRightNavigationBarClick | 监听导航栏右侧点击事件 | 待开发 | 待开发 | 待开发 |
# 页面离开二次确认
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| enableLeaveConfirm | 当某个页面返回或关闭时设置二次弹窗提示 | 待开发 | 待开发 | 待开发 |
| disableLeaveConfirm | 取消当前页面离开二次确认弹框 | 待开发 | 待开发 | 待开发 |
# 页面模式
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setPageOrientation | 设置页面横、竖屏配置 | 3.18.0 | 3.18.0 | X |
# 设备
# 系统信息
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getSystemInfo | 获取系统信息 | 3.3.0 | 3.3.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 |
| stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时，建议调用该接口停止蓝牙搜索 | 待开发 | 待开发 | X |
| getBluetoothDevices | 获取在蓝牙模块生效期间所有已发现的蓝牙设备。包括已经和本机处于连接状态的设备 | 待开发 | 待开发 | X |
# 扫码
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| scanCode | 扫描二维码并返回扫描结果 | 待开发 | 待开发 | X |
# Wi-Fi
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getConnectedWifi | 获取设备当前所连的 Wifi | 待开发 | 待开发 | 待开发 |
| getWifiStatus | 请求获取 Wi-Fi 开关状态 | 待开发 | 待开发 | X |
| getWifiList | 请求获取Wifi 列表 | 待开发 | 待开发 | 待开发 |
| onGetWifiList | 监听获取到 Wi-Fi 列表数据事件 | 待开发 | 待开发 | 待开发 |
| offGetWifiList | 取消监听获取到 Wi-Fi 列表数据事件 | 待开发 | 待开发 | 待开发 |
# 剪贴板
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setClipboardData | 设置系统剪贴板内容 | 待开发 | 待开发 | 待开发 |
| getClipboardData | 获取系统粘贴板数据 | 待开发 | 待开发 | 待开发 |
| setClipboardEvent | 文字选中时，打开/关闭复制等原生按钮的展示 | 3.18.0 | 3.18.0 | 待开发 |
# 网络状态
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| getNetworkType | 获取设备当前所处的网络类型 | 3.18.0 | 3.18.0 | 待开发 |
| onNetworkStatusChange | 监听网络状态变化 | 3.18.0 | 3.18.0 | 待开发 |
| getNetworkQualityType | 网络评级接口，获取当前设备所处的网络状态 | 待开发 | 待开发 | 待开发 |
| onNetworkQualityChange | 监听网络质量变化 | 待开发 | 待开发 | 待开发 |
# 屏幕亮度
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| setScreenBrightness | 设置屏幕亮度 | 待开发 | 待开发 | X` |
| getScreenBrightness | 获取屏幕亮度 | 待开发 | 待开发 | X |
| setKeepScreenOn | 设置是否保持常亮状态 | 待开发 | 待开发 | X |
# 截屏监听
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| onUserCaptureScreen | 监听用户主动截屏事件。用户使用系统截屏按键截屏时触发 | 待开发 | 待开发 | X |
| offUserCaptureScreen | 取消监听用户主动截屏事件 | 待开发 | 待开发 | X |
# 加速度计
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| startAccelerometer | 通知客户端开始监听加速度计数据。具体的数据返回通过注册onAccelerometerChange接口回调方法获取 | 待开发 | 待开发 | X |
| stopAccelerometer | 停止监听加速度计数据 | 待开发 | 待开发 | X |
| onAccelerometerChange | 监听加速度计数据 | 待开发 | 待开发 | X |
# 拨打电话
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| makePhoneCall | 拨打电话 | 待开发 | 待开发 | X |
# 震动
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| vibrateShort | 使手机发生较短时间的振动 | 待开发 | 待开发 | X |
| vibrateLong | 使手机发生较长时间的振动 | 待开发 | 待开发 | X |
# 罗盘
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| startCompass | 开始监听罗盘数据。 | 待开发 | 待开发 | X |
| stopCompass | 停止监听罗盘数据 | 待开发 | 待开发 | X |
# 文件
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| previewFile | 预览文件 | 3.16.0 | 3.16.0 | 3.18.0 |
| saveFile | 保存临时文件到本地永久目录 | 待开发 | 待开发 | 待开发 |
| filePicker | 打开附件选择列表 | 待开发 | 待开发 | 待开发 |
| docsPicker | 打开云文档选择列表 | 待开发 | 待开发 | 待开发 |
| openDocument | 在新页面打开文档 | 待开发 | 待开发 | 待开发 |
| getFileSystemManager | 获取全局唯一的文件管理器 | 待开发 | 待开发 | 待开发 |
| FileSystemManager.readFile | 读取本地文件内容 | 待开发 | 待开发 | 待开发 |
| FileSystemManager.stat | 获取本地文件 Stats 对象 | 待开发 | 待开发 | 待开发 |
| Stats.isDirectory | 判断当前文件是否一个目录 | 待开发 | 待开发 | 待开发 |
| Stats.isFile | 判断当前文件是否一个普通文件 | 待开发 | 待开发 | 待开发 |
# 媒体
# 图片
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| saveImageToPhotosAlbum | 保存图片到系统相册 | 待开发 | 待开发 | 待开发 |
| chooseImage | 从系统相册中选择图片，或使用相机拍摄图片 | 待开发 | 待开发 | 待开发 |
| previewImage | 预览一组图片 | 待开发 | 待开发 | 待开发 |
| compressImage | 压缩图片接口，可选压缩质量 | 待开发 | 待开发 | 待开发 |
| getImageInfo | 获取图片信息 | 待开发 | 待开发 | 待开发 |
# 视频
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| saveVideoToPhotosAlbum | 保存视频到系统相册 | 待开发 | 待开发 | 待开发 |
| chooseVideo | 从系统相册中选择视频，或使用相机拍摄视频 | 待开发 | 待开发 | 待开发 |
| chooseMedia | 拍摄或从系统相册中选择图片或视频 | 待开发 | 待开发 | 待开发 |
# 导航
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| closeWindow | 关闭当前窗口 | 3.3.0 | 3.3.0 | 待开发 |
| openSchema | 跳转到小程序以外的应用（如云文档、网页等） | 待开发 | 待开发 | 待开发 |
# 地理位置
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| openLocation | 使用客户端内置地图查看位置 | 待开发 | 待开发 | X |
| chooseLocation | 打开地图选择位置 | 待开发 | 待开发 | X |
| getLocation | 获取设备当前的地理位置 | 待开发 | 待开发 | X |
| startLocationUpdate | 开启小程序在前台时接收位置更新消息 | 待开发 | 待开发 | X |
| stopLocationUpdate | 关闭监听实时位置变化，停止位置消息接收 | 待开发 | 待开发 | X |
| onLocationChange | 监听实时地理位置变化事件，需结合startLocationUpdate使用 | 待开发 | 待开发 | X |
| offLocationChange | 取消监听实时地理位置变化事件 | 待开发 | 待开发 | X |
# App事件
| API名称 | 说明 | Android | iOS | PC |
|---|---|---|---|---|
| onAppVisibilityChange | 监听bosshi应用切前后台事件 | 3.18.0 | 3.18.0 | X |