bilibili小程序 API
bilibili 小程序为开发者提供了丰富的原生 API，可以方便的调起 bilibili 提供的能力，如获取用户信息，本地存储，支付功能等。
基础
小程序
- bl.offError - 取消监听小程序错误事件
- bl.onError - 监听小程序错误事件
- bl.onPageNotFound - 监听小程序页面不存在事件
- bl.getEnterOptionsSync - 获取小程序启动时的参数
- bl.getLaunchOptionsSync - 获取小程序启动时的参数
系统
- bl.getAppBaseInfo - 获取微信 APP 基础信息
- bl.getSystemInfo - 获取系统信息
- bl.getSystemInfoSync - 获取系统信息同步接口
更新
- bl.getUpdateManager - 获取全局唯一的版本更新管理器
- UpdateManager - UpdateManager 对象
编码解码
- bl.base64Encode - Base64 编码
- bl.base64Decode - Base64 解码
调试
- bl.setEnableDebug - 设置是否开启调试
其他
- bl.canIUse - 判断小程序的 API、回调、参数、组件等是否在当前版本可用
- bl.env - 环境变量
路由
路由跳转
- bl.navigateTo - 保留当前页面，跳转到应用内的某个页面
- bl.redirectTo - 关闭当前页面，跳转到应用内的某个页面
- bl.navigateBack - 关闭当前页面，返回上一页面或多级页面
- bl.switchTab - 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
- bl.reLaunch - 关闭所有页面，打开到应用内的某个页面
界面
交互反馈
- bl.showToast - 显示消息提示框
- bl.hideToast - 隐藏消息提示框
- bl.showModal - 显示模态对话框
- bl.showLoading - 显示 loading 提示框
- bl.hideLoading - 隐藏 loading 提示框
- bl.showActionSheet - 显示操作菜单
动画
- bl.createAnimation - 创建一个动画实例
- Animation - 动画实例
菜单
- bl.getMenuButtonBoundingClientRect - 获取菜单按钮的布局位置信息
滚动
- bl.pageScrollTo - 将页面滚动到目标位置
下拉刷新
- bl.startPullDownRefresh - 开始下拉刷新
- bl.stopPullDownRefresh - 停止下拉刷新
导航栏
- bl.setNavigationBarTitle - 动态设置当前页面的标题
- bl.setNavigationBarColor - 设置页面导航条颜色
- bl.showNavigationLeftButton - 显示导航栏左侧按钮
- bl.hideNavigationLeftButton - 隐藏导航栏左侧按钮
- bl.setStatusBarStyle - 设置状态栏样式
- bl.setStatusBarHidden - 隐藏状态栏
窗口
- bl.onWindowResize - 监听窗口尺寸变化事件
- bl.offWindowResize - 取消监听窗口尺寸变化事件
Tab Bar
- bl.setTabBarItem - 动态设置 tabBar 某一项的内容
- bl.setTabBarStyle - 动态设置 tabBar 的整体样式
- bl.showTabBar - 显示 tabBar
- bl.hideTabBar - 隐藏 tabBar
- bl.showTabBarRedDot - 显示 tabBar 某一项的右上角的红点
- bl.hideTabBarRedDot - 隐藏 tabBar 某一项的右上角的红点
- bl.setTabBarBadge - 为 tabBar 某一项的右上角添加文本
- bl.removeTabBarBadge - 移除 tabBar 某一项右上角的文本
字体和背景
- bl.loadFontFace - 动态加载网络字体
- bl.setBackgroundColor - 动态设置窗口的背景色
键盘
- bl.onKeyboardHeightChange - 监听键盘高度变化
- bl.getSelectedTextRange - 获取输入框的光标位置
网络
发起请求
- bl.request - 发起 HTTPS 网络请求
- RequestTask - 网络请求任务对象
下载
- bl.downloadFile - 下载文件资源到本地
- DownloadTask - 下载任务对象
上传
- bl.uploadFile - 将本地资源上传到服务器
- UploadTask - 上传任务对象
WebSocket
- bl.connectSocket - 创建一个 WebSocket 连接
- bl.closeSocket - 关闭 WebSocket 连接
- SocketTask - WebSocket 任务对象
- bl.onSocketOpen - 监听 WebSocket 连接打开事件
- bl.onSocketError - 监听 WebSocket 错误事件
- bl.onSocketMessage - 监听 WebSocket 接受到服务器的消息事件
- bl.onSocketClose - 监听 WebSocket 连接关闭事件
- bl.sendSocketMessage - 通过 WebSocket 连接发送数据
数据缓存
数据存储
- bl.setStorage - 将数据存储在本地缓存中指定的 key 中
- bl.setStorageSync - bl.setStorage 的同步版本
- bl.getStorage - 从本地缓存中异步获取指定 key 的内容
- bl.getStorageSync - bl.getStorage 的同步版本
- bl.removeStorage - 从本地缓存中移除指定 key
- bl.removeStorageSync - bl.removeStorage 的同步版本
- bl.clearStorage - 清理本地数据缓存
- bl.clearStorageSync - bl.clearStorage 的同步版本
- bl.getStorageInfo - 异步获取当前 storage 的相关信息
- bl.getStorageInfoSync - bl.getStorageInfo 的同步版本
媒体
图片
- bl.chooseImage - 从本地相册选择图片或使用相机拍照
- bl.previewImage - 在新页面中全屏预览图片
- bl.getImageInfo - 获取图片信息
- bl.saveImageToPhotosAlbum - 保存图片到系统相册
- bl.compressImage - 压缩图片接口
- bl.chooseMessageFile - 从客户端会话选择文件
- bl.cropImage - 裁剪图片接口
- bl.editImage - 编辑图片接口
- bl.previewMedia - 预览图片和视频
地理位置
- bl.getLocation - 获取当前的地理位置、速度
- bl.chooseLocation - 打开地图选择位置
- bl.openLocation - 使用内置地图查看位置
文件选择
- bl.chooseFile - 从客户端会话选择文件
- bl.chooseAddress - 获取用户收货地址
相机和录像
- bl.createCameraContext - 创建 camera 上下文 CameraContext 对象
- CameraContext - 相机上下文对象
音频
- bl.createInnerAudioContext - 创建内部 audio 上下文
- InnerAudioContext - 内部音频上下文
- bl.createAudioContext - 创建 audio 上下文
- bl.createWebAudioContext - 创建 WebAudio 上下文
- bl.createMediaAudioPlayer - 创建媒体音频播放器对象
- bl.getAvailableAudioSources - 获取当前支持的音频输入源
- bl.pauseVoice - 暂停正在播放的语音
- bl.playVoice - 开始播放语音
- bl.stopVoice - 结束播放语音
- bl.setInnerAudioOption - 设置 InnerAudioContext 的播放选项
视频
- bl.saveVideoToPhotosAlbum - 保存视频到系统相册
- bl.createVideoContext - 创建 video 上下文 VideoContext 对象
- VideoContext - 视频上下文对象
SVGA 动画
- bl.createSVGAContext - 创建 SVGA 动画上下文
- SVGAContext - SVGA 上下文对象
设备
系统信息
- bl.getBatteryInfo - 获取设备电量
- bl.getBatteryInfoSync - 获取设备电量同步接口
- bl.getNetworkType - 获取网络类型
- bl.onNetworkStatusChange - 监听网络状态变化事件
- bl.onMemoryWarning - 监听内存不足告警事件
摇一摇
- bl.onShakeChange - 监听摇一摇事件
- bl.offShakeChange - 取消监听摇一摇事件
- bl.startShake - 开始摇一摇监听
- bl.stopShake - 停止摇一摇监听
屏幕
- bl.setKeepScreenOn - 设置是否保持常亮状态
- bl.getScreenBrightness - 获取屏幕亮度
- bl.setScreenBrightness - 设置屏幕亮度
- bl.onUserCaptureScreen - 监听用户主动截屏事件
- bl.offUserCaptureScreen - 取消监听用户主动截屏事件
振动
- bl.vibrateLong - 使手机发生较长时间的振动
- bl.vibrateShort - 使手机发生较短时间的振动
加速计
- bl.startAccelerometer - 开始监听加速度数据
- bl.stopAccelerometer - 停止监听加速度数据
- bl.onAccelerometerChange - 监听加速度数据变化事件
- bl.offAccelerometerChange - 取消监听加速度数据变化事件
罗盘
- bl.startCompass - 开始监听罗盘数据
- bl.stopCompass - 停止监听罗盘数据
- bl.onCompassChange - 监听罗盘数据变化事件
- bl.offCompassChange - 取消监听罗盘数据变化事件
陀螺仪
- bl.startGyroscope - 开始监听陀螺仪数据
- bl.stopGyroscope - 停止监听陀螺仪数据
- bl.onGyroscopeChange - 监听陀螺仪数据变化事件
- bl.offGyroscopeChange - 取消监听陀螺仪数据变化事件
设备方向
- bl.startDeviceMotionListening - 开始监听设备方向的变化
- bl.stopDeviceMotionListening - 停止监听设备方向的变化
- bl.onDeviceMotionChange - 监听设备方向变化事件
- bl.offDeviceMotionChange - 取消监听设备方向变化事件
键盘
- bl.hideKeyboard - 在 input、textarea 等 focus 拉起键盘之后，手动调用此接口收起键盘
- bl.onKeyDown - 监听键盘按键按下事件
- bl.offKeyDown - 取消监听键盘按键按下事件
- bl.onKeyUp - 监听键盘按键松开事件
- bl.offKeyUp - 取消监听键盘按键松开事件
剪贴板
- bl.setClipboardData - 设置系统剪贴板的内容
- bl.getClipboardData - 获取系统剪贴板的内容
蓝牙-通用
- bl.openBluetoothAdapter - 初始化蓝牙模块
- bl.closeBluetoothAdapter - 关闭蓝牙模块
- bl.getBluetoothAdapterState - 获取本机蓝牙适配器状态
- bl.startBluetoothDevicesDiscovery - 开始搜寻附近的蓝牙外围设备
- bl.stopBluetoothDevicesDiscovery - 停止搜寻附近的蓝牙外围设备
- bl.getBluetoothDevices - 获取在蓝牙模块生效期间所有已发现的蓝牙设备
- bl.getConnectedBluetoothDevices - 根据 uuid 获取处于已连接状态的设备
- bl.onBluetoothDeviceFound - 监听寻找到新设备的事件
- bl.offBluetoothDeviceFound - 取消监听寻找到新设备的事件
- bl.onBluetoothAdapterStateChange - 监听蓝牙适配器状态变化事件
- bl.offBluetoothAdapterStateChange - 取消监听蓝牙适配器状态变化事件
蓝牙-低功耗中心设备
- bl.createBLEConnection - 连接低功耗蓝牙设备
- bl.closeBLEConnection - 断开与低功耗蓝牙设备的连接
- bl.getBLEDeviceServices - 获取蓝牙设备所有服务
- bl.getBLEDeviceCharacteristics - 获取蓝牙设备某个服务中所有特征值
- bl.readBLECharacteristicValue - 读取低功耗蓝牙设备的特征值的二进制数据值
- bl.writeBLECharacteristicValue - 向低功耗蓝牙设备特征值中写入二进制数据
- bl.notifyBLECharacteristicValueChange - 启用低功耗蓝牙设备特征值变化时的 notify 功能
- bl.onBLEConnectionStateChange - 监听低功耗蓝牙连接状态的改变事件
- bl.offBLEConnectionStateChange - 取消监听低功耗蓝牙连接状态的改变事件
- bl.onBLECharacteristicValueChange - 监听低功耗蓝牙设备的特征值变化事件
- bl.offBLECharacteristicValueChange - 取消监听低功耗蓝牙设备的特征值变化事件
文件
文件管理
- bl.getFileSystemManager - 获取文件系统管理器
- FileSystemManager - 文件系统管理器
- FileStats - 文件统计信息
- Stats - 描述文件状态的对象
开放接口
登录
- bl.login - 调用接口获取登录凭证
- bl.checkSession - 检查登录态是否过期
用户信息
- bl.getUserInfo - 获取用户信息
- bl.getAccountInfo - 获取当前帐号信息
- bl.getAccountInfoSync - 获取当前帐号信息的同步版本
- UserInfo - 用户信息
授权
- bl.authorize - 提前向用户发起授权请求
设置
- bl.getSetting - 获取用户的当前设置
- bl.openSetting - 调起客户端小程序设置界面
支付
- bl.requestPayment - 发起支付
跳转
- bl.navigateToMiniProgram - 打开另一个小程序
转发和分享
- bl.showShareMenu - 显示当前页面的转发按钮
- bl.hideShareMenu - 隐藏转发按钮
- bl.share - 分享功能
侧边栏能力
- bl.checkScene - 检查场景值
- bl.navigateToScene - 跳转到指定场景
添加到桌面
- bl.addShortcut - 添加桌面快捷方式
- bl.checkShortcut - 检查是否已添加桌面快捷方式
游戏相关
- bl.getFollowUpperStatus - 获取关注 UP 主状态
应用更新
- bl.updateApp - 更新客户端版本
BLML
SelectorQuery
- bl.createSelectorQuery - 返回一个 SelectorQuery 对象实例
- SelectorQuery - 查询节点信息的对象
- NodesRef - 节点引用
IntersectionObserver
- bl.createIntersectionObserver - 创建并返回一个 IntersectionObserver 对象实例
- IntersectionObserver - IntersectionObserver 对象，用于推断某些节点是否可以被用户看见、有多大比例可以被用户看见
MediaQueryObserver
- MediaQueryObserver - MediaQueryObserver 对象，用于监听页面 media query 变化
广告
激励视频广告
- createRewardedVideoAd - 创建激励视频广告组件
- RewardedVideoAd - 激励视频广告组件
AI 能力
人脸检测
- bl.createFaceDetection - 创建人脸检测实例
- FaceDetection - 人脸检测对象及其相关方法