# 基础
| 名称 | 功能说明 |
|---|---|
| qa.canIUse | 判断指定API(含调用方式/回调/参数/返回值/返回值的属性)或者组件(含属性)在当前快应用版本是否可用。 |
| qa.base64ToArrayBuffer | 将 Base64 字符串转成 ArrayBuffer 对象 |
| qa.arrayBufferToBase64 | 将 ArrayBuffer 对象转成 Base64 字符串 |
# 桌面图标
| 名称 | 功能说明 |
|---|---|
| qa.installShortcut | 创建桌面图标,每次创建都需要用户授权 |
| qa.hasInstalledShortcut | 获取桌面图标是否创建 |
| qa.systemPromptEnabled | 是否开启系统快捷方式创建弹窗 |
# 系统
# 系统信息
| 名称 | 功能说明 |
|---|---|
| qa.getSystemInfoSync | qa.getSystemInfo 的同步版本接口 |
| qa.getSystemInfo | 获取系统信息 |
# 快应用
# 应用级事件
| 名称 | 功能说明 |
|---|---|
| qa.onError | 监听快应用错误事件 |
| qa.onAppShow | 监听快应用切前台事件 |
| qa.onAppHide | 监听快应用切后台事件 |
| qa.offPageNotFound | 取消监听快应用要打开的页面不存在事件 |
| qa.offError | 取消监听快应用错误事件 |
| qa.offAppShow | 取消监听快应用切前台事件 |
| qa.offAppHide | 取消监听快应用切后台事件 |
# 调试
| 名称 | 功能说明 |
|---|---|
| qa.setEnableDebug | 设置是否打开调试开关 |
# 通知
| 名称 | 功能说明 |
|---|---|
| qa.showNotification | 显示通知 |
# console
| 名称 | 功能说明 |
|---|---|
| console.debug | 向调试面板中打印 debug 日志 |
| console.error | 向调试面板中打印 error 日志 |
| console.group | 在调试面板中创建一个新的分组 |
| console.groupEnd | 结束由 console.group 创建的分组 |
| console.info | 向调试面板中打印 info 日志 |
| console.log | 向调试面板中打印 log 日志 |
| console.warn | 向调试面板中打印 warn 日志 |
# 定时器
| 名称 | 功能说明 |
|---|---|
| clearInterval | 取消由 setInterval 设置的定时器 |
| clearTimeout | 取消由 setTimeout 设置的定时器 |
| setInterval | 设定一个定时器 |
| setTimeout | 设定一个定时器 |
# 路由
| 名称 | 功能说明 |
|---|---|
| qa.switchTab | 跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面 |
| qa.reLaunch | 关闭所有页面,打开到应用内的某个页面 |
| qa.redirectTo | 关闭当前页面,跳转到应用内的某个页面 |
| qa.navigateTo | 保留当前页面,跳转到应用内的某个页面 |
| qa.navigateBack | 关闭当前页面,返回上一页面或多级页面 |
# 界面
# 交互
| 名称 | 功能说明 |
|---|---|
| qa.showToast | 显示消息提示框 |
| qa.showModal | 显示模态对话框 |
| qa.showLoading | 显示 loading 提示框 |
| qa.showActionSheet | 显示操作菜单 |
| qa.hideToast | 隐藏消息提示框 |
| qa.hideLoading | 隐藏 loading 提示框 |
# 导航栏
| 名称 | 功能说明 |
|---|---|
| qa.showNavigationBarLoading | 显示当前页面的导航条加载动画 |
| qa.setNavigationBarTitle | 设置当前当前页面的标题,即时生效 |
| qa.setNavigationBarColor | 设置当前页面的导航条颜色 |
| qa.hideNavigationBarLoading | 隐藏当前页面的导航条加载动画 |
# menubar
| 名称 | 功能说明 |
|---|---|
| qa.setMenubarData | 设置当前页面 menubar 数据 |
# 背景
| 名称 | 功能说明 |
|---|---|
| qa.setBackgroundTextStyle | 动态设置下拉背景字体、loading 图的样式 |
| qa.setBackgroundColor | 动态设置窗口的背景色 |
# Tab Bar
| 名称 | 功能说明 |
|---|---|
| qa.showTabBarRedDot | 显示 tabBar 某一项的右上角的红点 |
| qa.showTabBar | 显示 tabBar |
| qa.setTabBarStyle | 动态设置 tabBar 的整体样式 |
| qa.setTabBarItem | 动态设置 tabBar 某一项的内容 |
| qa.setTabBarBadge | 为 tabBar 某一项的右上角添加文本 |
| qa.removeTabBarBadge | 移除 tabBar 某一项右上角的文本 |
| qa.hideTabBarRedDot | 隐藏 tabBar 某一项的右上角的红点 |
| qa.hideTabBar | 隐藏 tabBar |
# 字体
| 名称 | 功能说明 |
|---|---|
| qa.loadFontFace | 动态加载网络字体 |
# 下拉刷新
| 名称 | 功能说明 |
|---|---|
| qa.stopPullDownRefresh | 停止当前页面下拉刷新 |
| qa.startPullDownRefresh | 开始下拉刷新 |
# 滚动
| 名称 | 功能说明 |
|---|---|
| qa.pageScrollTo | 将页面滚动到目标位置 |
# 动画
| 名称 | 功能说明 |
|---|---|
| qa.createAnimation | 创建一个动画实例 animation |
# Animation
| 名称 | 功能说明 |
|---|---|
| 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 | 设置宽度 |
| Animation.backgroundColor | 设置背景色 |
| Animation.bottom | 设置 bottom 值 |
| Animation.export | 导出动画队列 |
# 自定义组件
| 名称 | 功能说明 |
|---|---|
| qa.nextTick | 延迟一部分操作到下一个时间片再执行 |
# 菜单
| 名称 | 功能说明 |
|---|---|
| qa.getMenuButtonBoundingClientRect | 获取菜单按钮(右上角menu按钮)的布局位置信息 |
# 键盘
| 名称 | 功能说明 |
|---|---|
| qa.hideKeyboard | 在input、textarea等focus拉起键盘之后,手动调用此接口收起键盘 |
# 网络
# 发起请求
| 名称 | 功能说明 |
|---|---|
| qa.request | 发起 HTTPS 网络请求的接口 |
# RequestTask
| 名称 | 功能说明 |
|---|---|
| RequestTask.abort | 中断该请求任务 |
# 下载
| 名称 | 功能说明 |
|---|---|
| qa.downloadFile | 下载文件资源到本地的接口 |
# DownloadTask
| 名称 | 功能说明 |
|---|---|
| DownloadTask.abort | 中断进行中的下载任务 |
| DownloadTask.offProgressUpdate | 取消订阅下载进度变化事件 |
| DownloadTask.onProgressUpdate | 订阅下载进度变化事件事件 |
# 上传
| 名称 | 功能说明 |
|---|---|
| qa.uploadFile | 将本地文件上传到服务器端 |
# UploadTask
| 名称 | 功能说明 |
|---|---|
| UploadTask.abort | 中断该上传任务 |
| UploadTask.offProgressUpdate | 取消订阅上传进度变化事件 |
| UploadTask.onProgressUpdate | 订阅上传进度变化事件回调 |
# WebSocket
| 名称 | 功能说明 |
|---|---|
| qa.sendSocketMessage | 通过已连接成功的WebSocket连接发送数据 |
| qa.onSocketOpen | 订阅WebSocket连接打开事件回调 |
| qa.onSocketMessage | 订阅WebSocket接受到服务器的消息事件回调 |
| qa.onSocketError | 订阅WebSocket错误事件回调 |
| qa.onSocketClose | 订阅WebSocket连接关闭事件回调 |
| qa.connectSocket | 创建新的WebSocket连接 |
| qa.closeSocket | 关闭WebSocket连接 |
# SocketTask
| 名称 | 功能说明 |
|---|---|
| SocketTask.close | 关闭当前WebSocket连接 |
| SocketTask.onClose | 订阅WebSocket连接关闭事件回调 |
| SocketTask.onError | 订阅WebSocket错误事件回调 |
| SocketTask.onMessage | 订阅WebSocket接受到服务器的消息事件回调 |
| SocketTask.onOpen | 订阅WebSocket连接打开事件回调 |
| SocketTask.send | 通过已创建的WebSocket连接发送数据 |
# 数据缓存
| 名称 | 功能说明 |
|---|---|
| qa.setStorageSync | qa.setStorage 的同步版本 |
| qa.setStorage | 将数据存储在本地缓存中指定的 key 中 |
| qa.removeStorageSync | qa.removeStorage 的同步版本 |
| qa.removeStorage | 从本地缓存中移除指定 key |
| qa.getStorageSync | qa.getStorage 的同步版本 |
| qa.getStorageInfoSync | qa.getStorageInfo 的同步版本 |
| qa.getStorageInfo | 异步获取当前 storage 的相关信息 |
| qa.getStorage | 从本地缓存中异步获取指定 key 的内容 |
| qa.clearStorageSync | qa.clearStorage 的同步版本 |
| qa.clearStorage | 清理本地数据缓存 |
# 媒体
# 地图
| 名称 | 功能说明 |
|---|---|
| qa.createMapContext | 创建 map 上下文 MapContext 对象 |
# MapContext
| 名称 | 功能说明 |
|---|---|
| MapContext.getCenterLocation | 获取当前地图中心的经纬度 |
| MapContext.getRegion | 获取当前地图的视野范围 |
| MapContext.getScale | 获取当前地图的缩放级别 |
| MapContext.includePoints | 缩放视野展示所有经纬度 |
| MapContext.moveToLocation | 将地图中心移动到当前定位点 |
| MapContext.translateMarker | 平移 marker,带动画 |
# 图片
| 名称 | 功能说明 |
|---|---|
| qa.saveImageToPhotosAlbum | 保存图片到系统相册 |
| qa.previewImage | 在新页面中全屏预览图片 |
| qa.getImageInfo | 获取图片信息 |
| qa.compressImage | 压缩图片接口,可选压缩质量 |
| qa.chooseImage | 从本地相册选择图片或使用相机拍照 |
# 视频
| 名称 | 功能说明 |
|---|---|
| qa.saveVideoToPhotosAlbum | 保存视频到系统相册 |
| qa.createVideoContext | 创建 video 上下文 VideoContext 对象 |
| qa.chooseVideo | 拍摄视频或从手机相册中选视频 |
# VideoContext
| 名称 | 功能说明 |
|---|---|
| VideoContext.exitFullScreen | 退出全屏 |
| VideoContext.pause | 暂停视频 |
| VideoContext.play | 播放视频 |
| VideoContext.requestFullScreen | 进入全屏 |
| VideoContext.seek | 跳转到指定位置 |
| VideoContext.stop | 停止视频 |
# 音频
| 名称 | 功能说明 |
|---|---|
| qa.setInnerAudioOption | 设置 InnerAudioContext 的播放选项 |
| qa.createInnerAudioContext | 创建用于音频播放 audio 的上下文 InnerAudioContext 对象 |
# InnerAudioContext
# 背景音频
| 名称 | 功能说明 |
|---|---|
| qa.stopBackgroundAudio | 停止播放音乐 |
| qa.seekBackgroundAudio | 控制音乐播放进度 |
| qa.playBackgroundAudio | 使用后台播放器播放音乐 |
| qa.pauseBackgroundAudio | 暂停播放音乐 |
| qa.onBackgroundAudioStop | 监听音乐停止事件 |
| qa.onBackgroundAudioPlay | 监听音乐播放事件 |
| qa.onBackgroundAudioPause | 监听音乐暂停事件 |
| qa.getBackgroundAudioPlayerState | 获取后台音乐播放状态 |
| qa.getBackgroundAudioManager | 获取全局唯一的背景音频管理器 |
# BackgroundAudioManager
| 名称 | 功能说明 |
|---|---|
| BackgroundAudioManager.onPlay | 监听背景音频播放事件 |
| BackgroundAudioManager.onSeeked | 监听背景音频完成跳转操作事件 |
| BackgroundAudioManager.onSeeking | 监听背景音频开始跳转操作事件 |
| BackgroundAudioManager.onStop | 监听背景音频停止事件 |
| BackgroundAudioManager.onTimeUpdate | 监听背景音频播放进度更新事件,只有快应用在前台时会回调 |
| BackgroundAudioManager.onWaiting | 监听音频加载中事件 |
| BackgroundAudioManager.pause | 暂停音乐 |
| BackgroundAudioManager.play | 播放音乐 |
| BackgroundAudioManager.seek | 跳转到指定位置 |
| BackgroundAudioManager.stop | 停止音乐 |
| BackgroundAudioManager.onCanplay | 监听背景音频进入可播放状态事件 |
| BackgroundAudioManager.onEnded | 监听背景音频自然播放结束事件 |
| BackgroundAudioManager.onError | 监听背景音频播放错误事件 |
| BackgroundAudioManager.onPause | 监听背景音频暂停事件 |
# 录音
| 名称 | 功能说明 |
|---|---|
| qa.stopRecord | 停止录音 |
| qa.startRecord | 开始录音 |
| qa.getRecorderManager | 获取全局唯一的录音管理器 RecorderManager |
# RecorderManager
| 名称 | 功能说明 |
|---|---|
| RecorderManager.onError | 订阅录音错误事件回调 |
| RecorderManager.onPause | 订阅录音暂停事件回调(只支持 Android 7.0 及以上设备) |
| RecorderManager.onResume | 订阅录音继续事件回调(只支持 Android 7.0 及以上设备) |
| RecorderManager.onStart | 订阅录音开始事件回调 |
| RecorderManager.onStop | 订阅录音结束事件回调 |
| RecorderManager.pause | 暂停录音 (只支持 Android 7.0 及以上设备) |
| RecorderManager.resume | 继续录音 (只支持 Android 7.0 及以上设备) |
| RecorderManager.start | 开始录音 |
| RecorderManager.stop | 停止录音 |
# 位置
| 名称 | 功能说明 |
|---|---|
| qa.openLocation | 使用快应用内置地图查看位置 |
| qa.getLocation | 获取当前的地理位置、速度 |
| qa.chooseLocation | 打开地图选择位置 |
# 画布
| 名称 | 功能说明 |
|---|---|
| qa.createCanvasContext | 创建 canvas 的绘图上下文 CanvasContext 对象 |
| qa.canvasPutImageData | 将像素数据绘制到画布 |
| qa.canvasGetImageData | 获取 canvas 区域隐含的像素数据 |
# CanvasContext
# CanvasGradient
| 名称 | 功能说明 |
|---|---|
| CanvasGradient.addColorStop | 添加颜色的渐变点 |
| Image | 图片对象 |
# 文件
| 名称 | 功能说明 |
|---|---|
| qa.saveFile | 保存文件到本地 |
| qa.removeSavedFile | 删除本地缓存文件 |
| qa.openDocument | 新开页面打开文档 |
| qa.getSavedFileList | 获取该快应用下已保存的本地缓存文件列表 |
| qa.getSavedFileInfo | 获取本地文件的文件信息 |
| qa.getFileInfo | 获取文件信息 |
# 开放接口
# account
| 名称 | 功能说明 |
|---|---|
| qa.isAccountLogin | 判断账户登录状态 |
| qa.getAccountProvider | 获取服务提供商 |
| qa.getAccountProfile | 获得用户基本信息 |
| qa.accountAuthorize | 进行 OAuth 授权 |
| qa.getAccountPhoneNumber | 获取当前手机登录的厂商账号的手机号码 |
# alipay
| 名称 | 功能说明 |
|---|---|
| qa.requestAliPayment | 使用支付宝完成支付 |
# 快应用跳转
| 名称 | 功能说明 |
|---|---|
| qa.navigateToQuickapp | 打开另一个快应用 |
| qa.navigateBackQuickapp | 返回到上一个快应用 |
# 授权
| 名称 | 功能说明 |
|---|---|
| qa.authorize | 提前向用户发起授权请求 |
# 设置
| 名称 | 功能说明 |
|---|---|
| qa.getSetting | 获取用户的当前设置 |
| AuthSetting | 用户授权设置信息,详情参考权限 |
# vendorpay
| 名称 | 功能说明 |
|---|---|
| qa.getVendorPaymentProvider | 获取服务提供商,同步接口 |
| qa.requestVendorPayment | 使用设备商提供的支付完成付款 |
# wxpay
| 名称 | 功能说明 |
|---|---|
| qa.getWxPaymentType | 获取当前可用的微信支付调用方式 |
| qa.requestWxPayment | 发起微信支付 |
# 广告
| 名称 | 功能说明 |
|---|---|
| qa.createInterstitialAd | 创建插屏广告 |
| qa.createRewardedVideoAd | 创建激励视频广告 |
# 设备
# Wi-Fi
| 名称 | 功能说明 |
|---|---|
| qa.stopWifi | 关闭 Wi-Fi 模块 |
| qa.startWifi | 初始化 Wi-Fi 模块 |
| qa.onWifiConnected | 监听连接上 Wi-Fi 的事件 |
| qa.onGetWifiList | 监听获取到 Wi-Fi 列表数据事件 |
| qa.getWifiList | 请求获取 Wi-Fi 列表 |
| qa.getConnectedWifi | 获取已连接中的 Wi-Fi 信息 |
| qa.connectWifi | 连接 Wi-Fi |
| WifiInfo | Wifi 信息 |
# 低功耗蓝牙
| 名称 | 功能说明 |
|---|---|
| qa.readBLECharacteristicValue | 读取低功耗蓝牙设备的特征值的二进制数据值 |
| qa.onBLEConnectionStateChange | 监听低功耗蓝牙连接状态的改变事件 |
| qa.onBLECharacteristicValueChange | 监听低功耗蓝牙设备的特征值变化事件 |
| qa.notifyBLECharacteristicValueChange | 启用低功耗蓝牙设备特征值变化时的 notify 功能,订阅特征值 |
| qa.getBLEDeviceServices | 获取蓝牙设备所有服务(service) |
| qa.getBLEDeviceCharacteristics | 获取蓝牙设备某个服务中所有特征值(characteristic) |
| qa.createBLEConnection | 连接低功耗蓝牙设备 |
| qa.closeBLEConnection | 断开与低功耗蓝牙设备的连接 |
| qa.writeBLECharacteristicValue | 向低功耗蓝牙设备特征值中写入二进制数据 |
# 联系人
| 名称 | 功能说明 |
|---|---|
| qa.addPhoneContact | 添加手机通讯录联系人 |
# 蓝牙
| 名称 | 功能说明 |
|---|---|
| qa.stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备 |
| qa.startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备 |
| qa.openBluetoothAdapter | 初始化蓝牙模块 |
| qa.onBluetoothDeviceFound | 监听寻找到新设备的事件 |
| qa.onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化事件 |
| qa.getConnectedBluetoothDevices | 根据 uuid 获取处于已连接状态的设备 |
| qa.getBluetoothDevices | 获取在蓝牙模块生效期间所有已发现的蓝牙设备 |
| qa.getBluetoothAdapterState | 获取本机蓝牙适配器状态 |
| qa.closeBluetoothAdapter | 关闭蓝牙模块 |
# 电量
| 名称 | 功能说明 |
|---|---|
| qa.getBatteryInfoSync | qa.getBatteryInfo 的同步版本 |
| qa.getBatteryInfo | 获取设备电量 |
# 剪贴板
| 名称 | 功能说明 |
|---|---|
| qa.setClipboardData | 设置系统剪贴板的内容 |
| qa.getClipboardData | 获取系统剪贴板的内容 |
# 网络
| 名称 | 功能说明 |
|---|---|
| qa.onNetworkStatusChange | 监听网络状态变化事件 |
| qa.getNetworkType | 获取网络类型 |
# 屏幕
| 名称 | 功能说明 |
|---|---|
| qa.setScreenBrightness | 设置屏幕亮度 |
| qa.setKeepScreenOn | 设置是否保持常亮状态 |
| qa.onUserCaptureScreen | 监听用户主动截屏事件 |
| qa.getScreenBrightness | 获取屏幕亮度 |
# 电话
| 名称 | 功能说明 |
|---|---|
| qa.makePhoneCall | 拨打电话 |
# 加速计
| 名称 | 功能说明 |
|---|---|
| qa.stopAccelerometer | 关闭加速度计监听器 |
| qa.startAccelerometer | 启动监听加速度计数据 |
| qa.onAccelerometerChange | 注册加速度数据回调监听器 |
# 罗盘
| 名称 | 功能说明 |
|---|---|
| qa.stopCompass | 关闭罗盘监听器 |
| qa.startCompass | 启动监听罗盘数据 |
| qa.onCompassChange | 注册罗盘数据回调监听器 |
# 设备方向
| 名称 | 功能说明 |
|---|---|
| qa.stopDeviceMotionListening | 关闭设备方向监听器 |
| qa.startDeviceMotionListening | 启动监听设备方向数据 |
| qa.onDeviceMotionChange | 注册设备方向变化数据回调监听器 |
# 陀螺仪
| 名称 | 功能说明 |
|---|---|
| qa.stopGyroscope | 关闭陀螺仪计监听器 |
| qa.startGyroscope | 启动监听陀螺仪数据 |
| qa.onGyroscopeChange | 注册陀螺仪数据回调监听器 |
# 性能
| 名称 | 功能说明 |
|---|---|
| qa.onMemoryWarning | 监听内存不足告警事件 |
# 扫码
| 名称 | 功能说明 |
|---|---|
| qa.scanCode | 调起客户端扫码界面进行扫码 |
# 振动
| 名称 | 功能说明 |
|---|---|
| qa.vibrateShort | 使手机发生较短时间的振动(15 ms) |
| qa.vibrateLong | 使手机发生较长时间的振动(400 ms) |
# QXML
| 名称 | 功能说明 |
|---|---|
| qa.createSelectorQuery | 返回一个 SelectorQuery 对象实例 |
| qa.createIntersectionObserver | 创建并返回一个 IntersectionObserver 对象实例 |
# IntersectionObserver
| 名称 | 功能说明 |
|---|---|
| IntersectionObserver.disconnect | 停止监听 |
| IntersectionObserver.observe | 指定目标节点并开始监听相交状态变化情况 |
| IntersectionObserver.relativeTo | 使用选择器指定一个节点,作为参照区域之一 |
| IntersectionObserver.relativeToViewport | 指定页面显示区域作为参照区域之一 |
# NodesRef
| 名称 | 功能说明 |
|---|---|
| NodesRef.boundingClientRect | 添加节点的布局位置的查询请求 |
| NodesRef.context | 添加节点的 Context 对象查询请求 |
| NodesRef.fields | 获取节点的相关信息 |
| NodesRef.scrollOffset | 添加节点的滚动位置查询请求 |
# SelectorQuery
| 名称 | 功能说明 |
|---|---|
| SelectorQuery.selectViewport | 选择显示区域 |
| SelectorQuery.exec | 执行所有的请求 |
| SelectorQuery.in | 将选择器的选取范围更改为自定义组件 component 内 |
| SelectorQuery.select | 在当前页面下选择第一个匹配选择器 selector 的节点 |
| SelectorQuery.selectAll | 在当前页面下选择匹配选择器 selector 的所有节点 |
在线客服