tencent cloud

文档反馈

API 概览

最后更新时间:2024-07-12 19:09:16

    1、基础

    1.1、系统能力

    名称
    功能说明
    最低版本
    canIUse
    判断小程序的 API,回调,参数,组件等是否在当前版本可用
    1.5.0
    env
    环境变量
    1.5.1
    将 Base64 字符串转成 ArrayBuffer 对象
    1.5.1
    将 ArrayBuffer 对象转成 Base64 字符串
    1.5.1

    1.2、系统

    名称
    功能说明
    最低版本
    异步调用获取系统信息
    1.5.0
    同步调用获取系统信息
    1.5.1
    异步获取系统信息
    1.5.1
    获取窗口信息
    1.5.1
    获取设备设置
    1.5.0
    跳转系统蓝牙设置页
    1.5.1
    跳转系统宿主客户端授权管理页
    1.5.1
    获取 Webview 小程序的 UserAgent
    1.5.1
    获取设备基础信息
    1.5.1
    获取宿主客户端基础信息
    1.5.1
    获取宿主客户端授权设置
    1.5.1

    1.3、更新

    名称
    功能说明
    最低版本
    获取全局唯一的版本更新管理器,用于管理小程序更新
    1.5.1
    强制小程序重启并使用新版本
    1.5.0
    监听向微信后台请求检查更新结果事件
    1.5.0
    监听小程序更新失败事件
    1.5.0
    监听小程序有版本更新事件
    1.5.0

    1.4、小程序

    名称
    功能说明
    最低版本
    获取小程序启动时的参数
    1.5.0
    获取本次小程序启动时的参数
    1.5.1
    onError
    监听小程序错误事件
    1.5.0
    offError
    移除小程序错误事件的监听函数
    1.5.0
    监听系统主题改变事件
    1.5.0
    移除系统主题改变事件的监听函数
    1.5.0
    监听小程序要打开的页面不存在事件
    1.5.1
    移除小程序要打开的页面不存在事件的监听函数
    1.5.1
    onAppShow
    监听小程序切前台事件
    1.5.1
    移除小程序切前台事件的监听函数
    1.5.1
    onAppHide
    监听小程序切后台事件
    1.5.1
    移除小程序切前台事件的监听函数
    1.5.1
    监听未处理的 Promise 拒绝事件
    1.5.1
    移除未处理的 Promise 拒绝事件的监听函数
    1.5.1

    1.5、调试

    名称
    功能说明
    最低版本
    设置是否打开调试开关
    1.5.0
    获取日志管理器对象
    1.5.1
    向调试面板中打印 debug 日志
    1.5.0
    向调试面板中打印 error 日志
    1.5.0
    在调试面板中创建一个新的分组
    1.5.0
    结束由 console.group 创建的分组
    1.5.0
    向调试面板中打印 info 日志
    1.5.0
    向调试面板中打印 log 日志
    1.5.0
    向调试面板中打印 warn 日志
    1.5.0
    写 debug 日志
    1.5.0
    写 info 日志
    1.5.0
    写 log 日志
    1.5.0
    写 warn 日志
    1.5.0
    添加过滤关键字
    1.5.16
    写 error 日志
    1.5.16
    可以获取当前缓存剩余空间
    1.5.16
    设置实时日志page参数所在的页面
    1.5.16
    写 info 日志
    1.5.16
    设置过滤关键字
    1.5.16
    写 warn 日志
    1.5.16
    添加过滤关键字
    1.5.16
    写 error日志
    1.5.16
    写 info 日志
    1.5.16
    设置过滤关键字
    1.5.16
    写 warn 日志
    1.5.16
    

    2、路由

    名称
    功能说明
    最低版本
    switchTab
    跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面
    1.5.0
    reLaunch
    关闭所有页面,打开到应用内的某个页面
    1.5.0
    关闭当前页面,跳转到应用内的某个页面
    1.5.0
    保留当前页面,跳转到应用内的某个页面
    1.5.1
    关闭当前页面,返回上一页面或多级页面
    1.5.0
    页面间事件通信通道
    1.5.1
    

    3、跳转

    名称
    功能说明
    最低版本
    退出当前小程序
    1.5.0
    打开另一个小程序
    1.5.0
    返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功
    1.5.1
    

    4、转发

    名称
    功能说明
    最低版本
    隐藏当前页面的转发按钮
    1.5.0
    显示当前页面的转发按钮
    1.5.0
    更新转发属性
    1.5.0
    打开分享图片弹窗
    1.5.35
    onCopyUrl
    监听用户点击右上角菜单的「复制链接」按钮时触发的事件
    1.5.35
    移除用户点击右上角菜单的「复制链接」按钮时触发的事件的全部监听函数
    1.5.35
    

    5、界面

    5.1、交互

    名称
    功能说明
    最低版本
    隐藏 loading 提示框
    1.5.0
    hideToast
    隐藏消息提示框
    1.5.0
    显示操作菜单
    1.5.0
    显示 loading 提示框
    1.5.0
    showModal
    显示模态对话框
    1.5.0
    showToast
    显示消息提示框
    1.5.0
    开启小程序页面返回询问对话框
    1.5.1
    关闭小程序页面返回询问对话框
    1.5.1

    5.2、导航栏

    名称
    功能说明
    最低版本
    动态设置当前页面的标题
    1.5.0
    设置页面导航条颜色
    1.5.0
    隐藏返回首页按钮
    1.5.0
    在当前页面显示导航条加载动画
    1.5.1
    在当前页面隐藏导航条加载动画
    1.5.1

    5.3、背景

    名称
    功能说明
    最低版本
    动态设置窗口的背景色
    1.5.0
    动态设置下拉背景字体、loading 图的样式
    1.5.0

    5.4、TabBar

    名称
    功能说明
    最低版本
    显示 tabBar
    1.5.0
    隐藏 tabBar
    1.5.0
    动态设置 tabBar 的整体样式
    1.5.0
    动态设置 tabBar 某一项的内容,2.7.0 起图片支持临时文件和网络文件
    1.5.0
    显示 tabBar 某一项的右上角的红点
    1.5.0
    隐藏 tabBar 某一项的右上角的红点
    1.5.0
    为 tabBar 某一项的右上角添加文本
    1.5.0
    移除 tabBar 某一项右上角的文本
    1.5.0

    5.5、下拉刷新

    名称
    功能说明
    最低版本
    开始下拉刷新
    1.5.0
    停止当前页面下拉刷新
    1.5.0

    5.6、滚动

    名称
    功能说明
    最低版本
    将页面滚动到目标位置,支持选择器和滚动距离两种方式定位
    1.5.0
    滚动至指定位置
    1.5.0
    滚动至指定位置
    1.5.0

    5.7、动画

    名称
    功能说明
    最低版本
    创建一个动画实例 animation
    1.5.0
    设置背景色
    1.5.0
    设置 bottom 值
    1.5.0
    导出动画队列
    1.5.0
    设置高度
    1.5.0
    设置 left 值
    1.5.0
    同 transform-function matrix
    1.5.0
    同 transform-function matrix3d
    1.5.0
    设置透明度
    1.5.0
    设置 right 值
    1.5.0
    从原点顺时针旋转一个角度
    1.5.0
    从 固定 轴顺时针旋转一个角度
    1.5.0
    从 X 轴顺时针旋转一个角度
    1.5.0
    从 Y 轴顺时针旋转一个角度
    1.5.0
    从 Z 轴顺时针旋转一个角度
    1.5.0
    缩放
    1.5.0
    缩放
    1.5.0
    缩放 X 轴
    1.5.0
    缩放 Y 轴
    1.5.0
    缩放 Z 轴
    1.5.0
    对 X、Y 轴坐标进行倾斜
    1.5.0
    对 X 轴坐标进行倾斜
    1.5.0
    对 Y 轴坐标进行倾斜
    1.5.0
    表示一组动画完成
    1.5.0
    设置 top 值
    1.5.0
    平移变换
    1.5.0
    对 xyz 坐标进行平移变换
    1.5.0
    对 X 轴平移
    1.5.0
    对 Y 轴平移
    1.5.0
    对 Z 轴平移
    1.5.0
    设置宽度
    1.5.0

    5.8、自定义组件

    名称
    功能说明
    最低版本
    nextTick
    延迟一部分操作到下一个时间片再执行
    1.5.0

    5.9、菜单

    名称
    功能说明
    最低版本
    获取菜单按钮(右上角胶囊按钮)的布局位置信息
    1.5.0

    5.10、窗口

    名称
    功能说明
    最低版本
    监听窗口尺寸变化事件
    1.5.0
    移除窗口尺寸变化事件的监听函数
    1.5.1

    5.11、字体

    名称
    功能说明
    最低版本
    动态加载网络字体
    1.5.0
    

    6、网络

    6.1、发起请求

    名称
    功能说明
    最低版本
    request
    发起 HTTPS 网络请求
    1.5.0
    中断请求任务
    1.5.0
    监听 Transfer-Encoding Chunk Received 事件
    1.5.1
    移除 Transfer-Encoding Chunk Received 事件的监听函数
    1.5.1
    监听 HTTP Response Header 事件
    1.5.0
    移除 HTTP Response Header 事件的监听函数
    1.5.0

    6.2、上传

    名称
    功能说明
    最低版本
    将本地资源上传到服务器
    1.5.0
    中断上传任务
    1.5.0
    监听上传进度变化事件
    1.5.0
    取消监听上传进度变化事件
    1.5.0
    监听 HTTP Response Header 事件
    1.5.0
    移除 HTTP Response Header 事件的监听函数
    1.5.0

    6.3、下载

    名称
    功能说明
    最低版本
    下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径),单次下载允许的最大文件为200MB
    1.5.1
    中断下载任务
    1.5.1
    监听下载进度变化事件
    1.5.1
    移除下载进度变化事件的监听函数
    1.5.1
    监听 HTTP Response Header 事件
    1.5.1
    移除 HTTP Response Header 事件的监听函数
    1.5.1

    6.4、WebSocket

    名称
    功能说明
    最低版本
    通过 WebSocket 连接发送数据。需要先 wx.connectSocket,并在 wx.onSocketOpen 回调之后才能发送
    1.5.1
    监听 WebSocket 连接打开事件
    1.5.1
    监听 WebSocket 接收到服务器的消息事件
    1.5.1
    监听 WebSocket 错误事件
    1.5.1
    监听 WebSocket 连接关闭事件
    1.5.1
    创建一个 WebSocket 连接
    1.5.1
    关闭 WebSocket 连接
    1.5.1
    关闭 WebSocket 连接
    1.5.0
    监听 WebSocket 连接关闭事件
    1.5.0
    监听 WebSocket 错误事件
    1.5.0
    监听 WebSocket 接收到服务器的消息事件
    1.5.0
    监听 WebSocket 连接打开事件
    1.5.0
    通过 WebSocket 连接发送数据
    1.5.0

    6.5、UDP 通信

    名称
    功能描述
    最低版本
    创建一个 UDP Socket 实例
    1.5.1
    绑定一个系统随机分配的可用端口,或绑定一个指定的端口号
    1.5.1
    关闭 UDP Socket 实例
    1.5.1
    预先连接到指定的 IP 和 port,需要配合 write 方法一起使用
    1.5.1
    监听关闭事件
    1.5.1
    移除关闭事件的监听函数
    1.5.1
    监听错误事件
    1.5.1
    移除错误事件的监听函数
    1.5.1
    监听开始监听数据包消息的事件
    1.5.1
    移除开始监听数据包消息的事件的监听函数
    1.5.1
    监听收到消息的事件
    1.5.1
    移除收到消息的事件的监听函数
    1.5.1
    向指定的 IP 和 port 发送消息
    1.5.1
    设置 IP_TTL 套接字选项,用于设置一个 IP 数据包传输时允许的最大跳步数
    1.5.16
    用法与 send 方法相同
    1.5.16

    6.6、TCP 通信

    名称
    功能说明
    最低版本
    创建一个 TCP Socket 实例
    1.5.1
    将 TCP Socket 绑定到当前 Wi-Fi 网络,成功后会触发 onBindWifi 事件(仅 Android 支持)
    1.5.1
    关闭连接
    1.5.1
    在给定的套接字上启动连接
    1.5.1
    监听一旦 socket 完全关闭就发出该事件
    1.5.1
    移除一旦 socket 完全关闭就发出该事件的监听函数
    1.5.1
    监听当一个 socket 连接成功建立的时候触发该事件
    1.5.1
    移除当一个 socket 连接成功建立的时候触发该事件的监听函数
    1.5.1
    监听当错误发生时触发
    1.5.1
    移除当错误发生时触发的监听函数
    1.5.1
    监听当接收到数据的时触发该事件
    1.5.1
    移除当接收到数据的时触发该事件的监听函数
    1.5.1
    监听当一个 socket 绑定当前 Wi-Fi 网络成功时触发该事件
    1.5.1
    移除当一个 socket 绑定当前 Wi-Fi 网络成功时触发该事件的监听函数
    1.5.1
    在 socket 上发送数据
    1.5.1

    6.7、mDNS

    名称
    功能说明
    最低版本
    停止搜索 mDNS 服务
    1.5.1
    开始搜索局域网下的 mDNS 服务
    1.5.1
    移除 mDNS 服务解析失败的事件的监听函数
    1.5.1
    监听 mDNS 服务解析失败的事件
    1.5.1
    移除 mDNS 服务离开的事件的监听函数
    1.5.1
    监听 mDNS 服务离开的事件
    1.5.1
    移除 mDNS 服务发现的事件的监听函数
    1.5.1
    监听 mDNS 服务发现的事件
    1.5.1
    移除 mDNS 服务停止搜索的事件的监听函数
    1.5.1
    监听 mDNS 服务停止搜索的事件
    1.5.1
    

    7、数据缓存

    名称
    功能说明
    最低版本
    将数据存储在本地缓存中指定的 key 中
    1.5.0
    将数据存储在本地缓存中指定的 key 中
    1.5.0
    根据 URL 销毁存在内存中的数据
    1.5.35
    从本地缓存中移除指定 key
    1.5.0
    removeStorage的同步版本
    1.5.0
    从本地缓存中异步获取指定 key 的内容
    1.5.0
    根据传入的 buffer 创建一个唯一的 URL 存在内存中
    1.5.35
    从本地缓存中同步获取指定 key 的内容
    1.5.0
    异步获取当前 storage 的相关信息
    1.5.0
    getStorageInfo的同步版本
    1.5.0
    清理本地数据缓存
    1.5.0
    clearStorage的同步版本
    1.5.0
    将数据批量存储在本地缓存中指定的 key 中
    1.5.16
    batchSetStorage 的同步版本
    1.5.16
    从本地缓存中异步批量获取指定 key 的内容
    1.5.16
    batchGetStorage 的同步版本
    1.5.16
    

    8、数据分析

    名称
    功能说明
    最低版本
    事件上报
    1.5.16
    

    9、画布

    9.1、画布概要

    名称
    功能说明
    最低版本
    创建离屏 canvas 实例
    1.5.19
    创建 canvas 的绘图上下文 CanvasContext 对象
    1.5.0
    把当前画布指定区域的内容导出生成指定大小的图片
    1.5.0
    将像素数据绘制到画布
    1.5.0
    获取 canvas 区域隐含的像素数据
    1.5.0
    Image
    图片对象
    1.5.16
    ImageData
    ImageData 对象
    1.5.16
    Canvas 绘图上下文
    1.5.16

    9.2、canvasContext

    名称
    功能说明
    最低版本
    CanvasContext.arc
    创建一条弧线
    1.5.0
    CanvasContext.arcTo
    根据控制点和半径绘制圆弧路径
    1.5.0
    CanvasContext.beginPath
    开始创建一个路径
    1.5.0
    CanvasContext.bezierCurveTo
    创建三次方贝塞尔曲线路径
    1.5.0
    CanvasContext.clearRect
    清除画布上在该矩形区域内的内容
    1.5.0
    CanvasContext.clip
    从原始画布中剪切任意形状和尺寸
    1.5.0
    CanvasContext.closePath
    关闭一个路径
    1.5.0
    CanvasContext.createCircularGradient
    创建一个圆形的渐变颜色
    1.5.0
    CanvasContext.createLinearGradient
    创建一个线性的渐变颜色
    1.5.0
    CanvasContext.createPattern
    对指定的图像创建模式的方法,可在指定的方向上重复元图像
    1.5.0
    CanvasContext.draw
    将之前在绘图上下文中的描述(路径、变形、样式)画到 canvas 中
    1.5.0
    CanvasContext.drawImage
    绘制图像到画布
    1.5.0
    CanvasContext.fill
    对当前路径中的内容进行填充
    1.5.0
    CanvasContext.fillRect
    填充一个矩形
    1.5.0
    CanvasContext.fillText
    在画布上绘制被填充的文本
    1.5.0
    CanvasContext.lineTo
    增加一个新点,然后创建一条从上次指定点到目标点的线
    1.5.0
    CanvasContext.measureText
    测量文本尺寸信息
    1.5.0
    CanvasContext.moveTo
    把路径移动到画布中的指定点,不创建线条
    1.5.0
    CanvasContext.quadraticCurveTo
    创建二次贝塞尔曲线路径
    1.5.0
    CanvasContext.rect
    创建一个矩形路径
    1.5.0
    CanvasContext.restore
    恢复之前保存的绘图上下文
    1.5.0
    CanvasContext.rotate
    以原点为中心顺时针旋转当前坐标轴
    1.5.0
    CanvasContext.save
    保存绘图上下文
    1.5.0
    CanvasContext.scale
    在调用后,之后创建的路径其横纵坐标会被缩放
    1.5.0
    CanvasContext.setFillStyle
    设置填充色
    1.5.0
    CanvasContext.setFontSize
    设置字体的字号
    1.5.0
    CanvasContext.setGlobalAlpha
    设置全局画笔透明度
    1.5.0
    CanvasContext.setLineCap
    设置线条的端点样式
    1.5.0
    CanvasContext.setLineDash
    设置虚线样式
    1.5.0
    CanvasContext.setLineJoin
    设置线条的交点样式
    1.5.0
    CanvasContext.setLineWidth
    设置线条的宽度
    1.5.0
    CanvasContext.setMiterLimit
    设置最大斜接长度
    1.5.0
    CanvasContext.setShadow
    设定阴影样式
    1.5.0
    CanvasContext.setStrokeStyle
    设置描边颜色
    1.5.0
    CanvasContext.setTextAlign
    设置文字的对齐
    1.5.0
    CanvasContext.setTextBaseline
    设置文字的竖直对齐
    1.5.0
    CanvasContext.setTransform
    使用矩阵重新设置(覆盖)当前变换的方法
    1.5.0
    CanvasContext.stroke
    画出当前路径的边框
    1.5.0
    CanvasContext.strokeRect
    画一个矩形(非填充)
    1.5.0
    CanvasContext.strokeText
    给定的 (x, y) 位置绘制文本描边的方法
    1.5.0
    CanvasContext.transform
    使用矩阵多次叠加当前变换的方法
    1.5.0
    CanvasContext.translate
    对当前坐标系的原点 (0, 0) 进行变换
    1.5.0

    9.3、CanvasGradient

    名称
    功能说明
    最低版本
    添加颜色的渐变点
    1.5.0

    9.4、Canvas

    名称
    功能说明
    最低版本
    取消由 requestAnimationFrame 添加到计划中的动画请求
    1.5.16
    创建一个ImageData 对象
    1.5.16
    创建一个图片对象
    1.5.16
    创建 Path2D 对象
    1.5.16
    该方法返回 Canvas 的绘图上下文
    1.5.16
    在下次进行重绘时执行
    1.5.16
    返回一个包含图片展示的 data URl
    1.5.16

    9.5、OffscreenCanvas

    名称
    功能说明
    最低版本
    该方法返回 OffscreenCanvas 的绘图上下文
    1.5.16
    创建一个图片对象
    1.5.16

    9.6、Path2D

    名称
    功能说明
    最低版本
    添加路径到当前路径
    1.5.16
    添加一段圆弧路径
    1.5.16
    通过给定控制点添加一段圆弧路径
    1.5.16
    添加三次贝塞尔曲线路径
    1.5.16
    闭合路径到起点
    1.5.16
    添加椭圆弧路径
    1.5.16
    添加直线路径
    1.5.16
    移动路径开始点
    1.5.16
    添加二次贝塞尔曲线路径
    1.5.16
    添加方形路径
    1.5.16
    

    10、媒体

    10.1、地图

    名称
    功能说明
    最低版本
    创建 map 上下文 MapContext 对象
    1.5.0
    添加弧线
    1.5.16
    添加个性化图层
    1.5.16
    创建自定义图片图层
    1.5.16
    添加 marker
    1.5.0
    擦除或置灰已添加到地图中的线段
    1.5.16
    获取屏幕上的点对应的经纬度,坐标原点为地图左上角
    1.5.0
    获取当前地图中心的经纬度
    1.5.0
    获取当前地图的视野范围
    1.5.0
    获取当前地图的旋转角
    1.5.0
    获取当前地图的缩放级别
    1.5.0
    获取当前地图的倾斜角
    1.5.0
    缩放视野展示所有经纬度
    1.5.0
    初始化点聚合的配置
    1.5.16
    沿指定路径移动 marker,用于轨迹回放等场景
    1.5.0
    将地图中心移置当前定位点,此时需设置地图组件 show-location 为 true
    1.5.0
    监听地图事件
    1.5.16
    拉起地图 APP 选择导航
    1.5.0
    删除弧线
    1.5.16
    移除个性化图层
    1.5.16
    移除自定义图片图层
    1.5.16
    移除 marker
    1.5.0
    限制地图的显示范围
    1.5.16
    设置地图中心点偏移
    1.5.16
    设置定位点图标
    1.5.16
    获取经纬度对应的屏幕坐标
    1.5.16
    平移marker,带动画
    1.5.0
    更新自定义图片图层
    1.5.16

    10.2、图片

    名称
    功能说明
    最低版本
    从本地相册选择图片或使用相机拍照
    1.5.0
    压缩图片接口,可选压缩质量
    1.5.1
    获取图片信息
    1.5.0
    在新页面中全屏预览图片
    1.5.0
    预览图片和视频
    1.5.1
    保存图片到系统相册
    1.5.1

    10.3、实时音视频

    名称
    功能
    最低版本
    创建 live-pusher 上下文 LivePusherContext 对象
    1.5.0
    创建 live-player 上下文 LivePlayerContext 对象
    1.5.0
    退出全屏
    1.5.0
    静音
    1.5.0
    暂停
    1.5.0
    播放
    1.5.0
    进入全屏
    1.5.0
    恢复
    1.5.0
    截图
    1.5.0
    停止
    1.5.0
    开始推流,同时开启摄像头预览
    1.5.0
    停止推流,同时停止摄像头预览
    1.5.0
    暂停推流
    1.5.0
    恢复推流
    1.5.0
    切换前后摄像头
    1.5.0
    快照
    1.5.0
    切换手电筒
    1.5.0
    播放背景音
    1.5.0
    停止背景音
    1.5.0
    暂停背景音
    1.5.0
    恢复背景音
    1.5.0
    设置背景音进度
    1.5.0
    设置麦克风音量
    1.5.0
    设置背景音量
    1.5.0
    设置混音类型
    1.5.0
    开启摄像头预览
    1.5.0
    关闭摄像头预览
    1.5.0
    开始录音
    1.5.0
    结束录音
    1.5.0

    10.4、音频

    名称
    功能说明
    最低版本
    stopVoice
    结束播放语音
    1.5.1
    playVoice
    开始播放语音
    1.5.1
    暂停正在播放的语音
    1.5.1
    设置 InnerAudioContext 的播放选项
    1.5.0
    获取当前支持的音频输入源
    1.5.1
    createInnerAudioContext
    创建内部 'audio'组件 上下文 InnerAudioContext 对象
    1.5.0
    AudioContext.pause
    暂停音频
    1.5.1
    AudioContext.play
    播放音频
    1.5.1
    AudioContext.seek
    跳转到指定位置
    1.5.1
    AudioContext.setSrc
    设置音频地址
    1.5.1
    InnerAudioContext.destroy
    销毁当前实例
    1.5.0
    InnerAudioContext.offCanplay
    移除音频进入可以播放状态的事件的监听函数
    1.5.0
    InnerAudioContext.offEnded
    移除音频自然播放至结束的事件的监听函数
    1.5.0
    InnerAudioContext.offError
    移除音频播放错误事件的监听函数
    1.5.0
    InnerAudioContext.offPause
    移除音频暂停事件的监听函数
    1.5.0
    InnerAudioContext.offPlay
    移除音频播放事件的监听函数
    1.5.0
    InnerAudioContext.offSeeked
    移除音频完成跳转操作的事件的监听函数
    1.5.0
    InnerAudioContext.offSeeking
    移除音频进行跳转操作的事件的监听函数
    1.5.0
    InnerAudioContext.offStop
    移除音频停止事件的监听函数
    1.5.0
    InnerAudioContext.offTimeUpdate
    移除音频播放进度更新事件的监听函数
    1.5.0
    InnerAudioContext.offWaiting
    移除音频加载中事件的监听函数
    1.5.0
    InnerAudioContext.onCanplay
    监听音频进入可以播放状态的事件
    1.5.0
    InnerAudioContext.onEnded
    监听音频自然播放至结束的事件
    1.5.0
    InnerAudioContext.onError
    监听音频播放错误事件
    1.5.0
    InnerAudioContext.onPause
    监听音频暂停事件
    1.5.0
    InnerAudioContext.onPlay
    监听音频播放事件
    1.5.0
    InnerAudioContext.onSeeked
    监听音频完成跳转操作的事件
    1.5.0
    InnerAudioContext.onSeeking
    监听音频进行跳转操作的事件
    1.5.0
    InnerAudioContext.onStop
    监听音频停止事件
    1.5.0
    InnerAudioContext.onTimeUpdate
    监听音频播放进度更新事件
    1.5.0
    InnerAudioContext.onWaiting
    监听音频加载中事件
    1.5.0
    InnerAudioContext.pause
    暂停
    1.5.0
    InnerAudioContext.play
    播放
    1.5.0
    InnerAudioContext.seek
    跳转到指定位置
    1.5.0
    InnerAudioContext.stop
    停止
    1.5.0

    10.5、视频

    名称
    说明
    最低版本
    保存视频到系统相册
    1.5.0
    创建 video 上下文 VideoContext 对象
    1.5.0
    拍摄视频或从手机相册中选视频
    1.5.0
    压缩视频接口
    1.5.1
    拍摄或从手机相册中选择图片或视频
    1.5.1
    退出全屏
    1.5.0
    退出后台音频播放模式
    1.5.16
    退出小窗,该方法可在任意页面调用
    1.5.16
    隐藏状态栏,仅在 iOS 全屏下有效
    1.5.0
    暂停视频
    1.5.0
    播放视频
    1.5.0
    进入全屏
    1.5.0
    进入后台音频播放模式
    1.5.16
    跳转到指定位置
    1.5.0
    发送弹幕
    1.5.0
    显示状态栏,仅在 iOS 全屏下有效
    1.5.0
    停止视频
    1.5.0

    10.6、透明视频

    名称
    说明
    最低版本
    创建 animation-video 上下文 AnimationVideoContext 对象
    1.5.0
    播放视频
    1.5.0
    暂停视频
    1.5.0
    跳转到指定位置
    1.5.0

    10.7、相机

    名称
    功能说明
    最低版本
    创建 camera 上下文 CameraContext 对象
    1.5.0
    获取 Camera 实时帧数据
    1.5.0
    设置缩放级别
    1.5.0
    开始录像
    1.5.0
    结束录像
    1.5.0
    拍摄照片
    1.5.0
    开始监听帧数据
    1.5.0
    停止监听帧数据
    1.5.0

    10.8、录音

    名称
    功能
    最低版本
    开始录音
    1.5.1
    停止录音
    1.5.1
    获取全局唯一的录音管理器 RecorderManager
    1.5.0
    监听录音错误事件
    1.5.0
    监听已录制完指定帧大小的文件事件
    1.5.0
    监听录音因为受到系统占用而被中断开始事件
    1.5.0
    监听录音中断结束事件
    1.5.0
    监听录音暂停事件
    1.5.0
    监听录音继续事件
    1.5.0
    监听录音开始事件
    1.5.0
    监听录音结束事件
    1.5.0
    暂停录音
    1.5.0
    继续录音
    1.5.0
    开始录音
    1.5.0
    暂停录音
    1.5.0

    10.9、背景音频

    名称
    说明
    最低版本
    停止播放音乐
    1.5.1
    控制音乐播放进度
    1.5.1
    使用后台播放器播放音乐
    1.5.1
    暂停播放音乐监听音乐停止事件
    1.5.1
    监听音乐停止事件
    1.5.1
    监听音乐播放事件
    1.5.1
    监听音乐暂停事件
    1.5.1
    获取后台音乐播放状态
    1.5.1
    获取全局唯一的背景音频管理器
    1.5.1
    监听背景音频进入可播放状态事件
    1.5.16
    监听背景音频自然播放结束事件
    1.5.16
    监听背景音频播放错误事件
    1.5.16
    监听用户在系统音乐播放面板点击下一曲事件(仅iOS)
    1.5.16
    监听背景音频暂停事件
    1.5.16
    监听背景音频播放事件
    1.5.16
    监听用户在系统音乐播放面板点击上一曲事件(仅iOS)
    1.5.16
    监听背景音频完成跳转操作事件
    1.5.16
    监听背景音频开始跳转操作事件
    1.5.16
    监听背景音频停止事件
    1.5.16
    监听背景音频播放进度更新事件
    1.5.16
    监听音频加载中事件
    1.5.16
    暂停音乐
    1.5.16
    播放音乐
    1.5.16
    跳转到指定位置
    1.5.16
    停止音乐
    1.5.16

    10.10、富文本

    名称
    说明
    最低版本
    EditorContext 实例
    1.5.16
    编辑器失焦,同时收起键盘
    1.5.16
    清空编辑器内容
    1.5.16
    修改样式
    1.5.16
    获取编辑器内容
    1.5.16
    获取编辑器已选区域内的纯文本内容
    1.5.16
    插入分割线
    1.5.16
    插入图片
    1.5.16
    覆盖当前选区,设置一段文本
    1.5.16
    恢复
    1.5.16
    清除当前选区的样式
    1.5.16
    使得编辑器光标处滚动到窗口可视区域内
    1.5.16
    初始化编辑器内容
    1.5.16
    撤销
    1.5.1
    

    11、文件

    11.1、文件概要

    名称
    说明
    最低版本
    saveFile
    保存文件到本地
    1.5.0
    删除本地缓存文件
    1.5.0
    新开页面打开文档
    1.5.0
    获取该小程序下已保存的本地缓存文件列表
    1.5.0
    获取本地文件的文件信息
    1.5.0
    获取全局唯一的文件管理器
    1.5.0
    获取文件信息
    1.5.0
    文件读取结果
    1.5.16
    文件写入结果
    1.5.16

    11.2、FileSystemManager

    API
    说明
    最低版本
    判断文件/目录是否存在
    1.5.0
    FileSystemManager.access 的同步版本
    1.5.0
    在文件结尾追加内容
    1.5.0
    FileSystemManager.appendFile 的同步版本
    1.5.0
    关闭文件
    1.5.16
    同步关闭文件
    1.5.16
    复制文件
    1.5.0
    FileSystemManager.copyFile 的同步版本
    1.5.0
    获取文件的状态信息
    1.5.16
    同步获取文件的状态信息
    1.5.16
    对文件内容进行截断操作FileSystemManager.open
    1.5.16
    对文件内容进行截断操作
    1.5.16
    获取该小程序下的 本地临时文件 或 本地缓存文件 信息
    1.5.0
    获取该小程序下已保存的本地缓存文件列表
    1.5.0
    创建目录
    1.5.0
    FileSystemManager.mkdir 的同步版本
    1.5.0
    打开文件,返回文件描述符
    1.5.16
    同步打开文件,返回文件描述符
    1.5.16
    读文件
    1.5.16
    读文件
    1.5.16
    读取指定压缩类型的本地文件内容
    1.5.16
    同步读取指定压缩类型的本地文件内容
    1.5.16
    读取目录内文件列表
    1.5.0
    FileSystemManager.readdir 的同步版本
    1.5.0
    读取本地文件内容
    1.5.0
    FileSystemManager.readFile 的同步版本
    1.5.0
    读取压缩包内的文件
    1.5.16
    删除该小程序下已保存的本地缓存文件
    1.5.0
    重命名文件
    1.5.0
    FileSystemManager.rename 的同步版本
    1.5.0
    删除目录
    1.5.0
    FileSystemManager.rmdir 的同步版本
    1.5.0
    保存临时文件到本地
    1.5.0
    FileSystemManager.saveFile 的同步版本
    1.5.0
    获取文件 Stats 对象
    1.5.0
    FileSystemManager.stat 的同步版本
    1.5.0
    对文件内容进行截断操作
    1.5.16
    对文件内容进行截断操作 (truncate 的同步版本)
    1.5.16
    删除文件
    1.5.0
    FileSystemManager.unlink 的同步版本
    1.5.0
    解压文件
    1.5.0
    写入文件
    1.5.16
    同步写入文件
    1.5.16
    写文件
    1.5.0
    FileSystemManager.writeFile 的同步版本
    1.5.0

    11.3、Stats

    API
    说明
    最低版本
    判断当前文件是否一个目录
    1.5.0
    判断当前文件是否一个普通文件
    1.5.0
    

    12、开放接口

    12.1、登录

    名称
    功能说明
    最低版本
    login
    调用接口获取登录凭证(code)
    1.5.1
    检查登录态是否过期
    1.5.1

    12.2、账号信息

    名称
    功能说明
    最低版本
    获取当前账号信息
    1.5.1

    12.3、用户信息

    名称
    功能说明
    最低版本
    获取用户信息
    1.5.1
    获取用户信息,在使用过程中需要用户授权 scope.userInfo
    1.5.1
    userInfo
    用户信息
    1.5.0

    12.4、设置

    名称
    功能说明
    最低版本
    用户授权设置信息
    1.5.0
    获取用户的当前设置
    1.5.0
    调起客户端小程序设置界面,返回用户设置的操作结果
    1.5.0

    12.5、生物认证

    名称
    功能说明
    最低版本
    校验设备内是否录入生物信息
    1.5.0
    校验本机是否支持生物认证
    1.5.0
    开始生物认证
    1.5.0

    12.6、授权

    名称
    功能说明
    最低版本
    authorize
    提前向用户发起授权请求
    1.5.0
    

    13、位置

    名称
    功能说明
    最低版本
    获取当前的地理位置、速度
    1.5.0
    choosePoi
    打开 POI 列表选择位置,支持模糊定位(精确到市)和精确定位混选
    1.5.0
    打开地图选择位置
    1.5.0
    关闭监听实时位置变化,前后台都停止消息接收
    1.5.0
    开启小程序进入前后台时均接收位置消息,需引导用户开启'授权'
    1.5.0
    开启小程序进入前台时接收位置消息
    1.5.0
    使用微信内置地图查看位置
    1.5.0
    监听持续定位接口返回失败时触发
    1.5.0
    监听实时地理位置变化事件,需结合 startLocationUpdateBackground、startLocationUpdate 使用
    1.5.0
    移除持续定位接口返回失败时触发
    1.5.0
    取消监听实时地理位置变化事件
    1.5.0
    获取当前的模糊地理位置
    1.5.0
    

    14、设备

    14.1、蓝牙通用

    名称
    功能说明
    最低版本
    停止搜寻附近的蓝牙外围设备
    1.5.0
    开始搜寻附近的蓝牙外围设备
    1.5.0
    初始化蓝牙模块
    1.5.1
    根据主服务 UUID 获取已连接的蓝牙设备
    1.5.1
    获取在蓝牙模块生效期间所有搜索到的蓝牙设备
    1.5.1
    获取本机蓝牙适配器状态
    1.5.1
    关闭蓝牙模块
    1.5.1
    监听搜索到新设备的事件
    1.5.0
    移除搜索到新设备的事件的全部监听函数
    1.5.0
    监听蓝牙适配器状态变化事件
    1.5.0
    移除蓝牙适配器状态变化事件的全部监听函数
    1.5.0
    蓝牙配对接口,仅 Android 支持
    1.5.0
    查询蓝牙设备是否配对,仅 Android 支持
    1.5.0

    14.2、蓝牙-低功耗中心设备

    名称
    功能说明
    最低版本
    向蓝牙低功耗设备特征值中写入二进制数据
    1.5.1
    读取蓝牙低功耗设备特征值的二进制数据
    1.5.1
    setBLEMTU
    协商设置蓝牙低功耗的最大传输单元
    1.5.1
    getBLEMTU
    获取蓝牙低功耗的最大传输单元
    1.5.1
    监听蓝牙低功耗的最大传输单元变化事件(仅 Android 触发)
    1.5.1
    移除蓝牙低功耗的最大传输单元变化事件的监听函数
    1.5.1
    监听蓝牙低功耗连接状态改变事件
    1.5.1
    移除蓝牙低功耗连接状态改变事件的监听函数
    1.5.1
    监听蓝牙低功耗设备的特征值变化事件
    1.5.1
    移除蓝牙低功耗设备的特征值变化事件的全部监听函数
    1.5.1
    启用蓝牙低功耗设备特征值变化时的 notify 功能,订阅特征
    1.5.1
    获取蓝牙低功耗设备所有服务 (service)
    1.5.1
    获取蓝牙低功耗设备的信号强度
    1.5.1
    获取蓝牙低功耗设备某个服务中所有特征
    1.5.1
    连接蓝牙低功耗设备
    1.5.1
    断开与蓝牙低功耗设备的连接
    1.5.1

    14.3、蓝牙-低功耗外围设备

    名称
    功能说明
    最低版本
    监听当前外围设备被连接或断开连接事件
    1.5.1
    移除当前外围设备被连接或断开连接事件的监听函数
    1.5.1
    建立本地作为蓝牙低功耗外围设备的服务端
    1.5.1
    添加服务
    1.5.1
    移除服务
    1.5.1
    开始广播本地创建的外围设备
    1.5.1
    停止广播
    1.5.1
    往指定特征写入二进制数据值,并通知已连接的主机
    1.5.1
    监听已连接的设备请求写当前外围设备的特征值事件
    1.5.1
    移除已连接的设备请求写当前外围设备的特征值事件的监听函数
    1.5.1
    监听已连接的设备请求读当前外围设备的特征值事件
    1.5.1
    移除已连接的设备请求读当前外围设备的特征值事件的监听函数
    1.5.1
    监听特征订阅事件,仅 iOS 支持
    1.5.1
    移除特征订阅事件的监听函数
    1.5.1
    监听取消特征订阅事件,仅 iOS 支持
    1.5.1
    移除取消特征订阅事件的监听函数
    1.5.1

    14.4、蓝牙-信标

    名称
    功能说明
    最低版本
    停止搜索附近的 Beacon 设备
    1.5.1
    开始搜索附近的 Beacon 设备
    1.5.1
    监听 Beacon 设备更新事件,仅能注册一个监听
    1.5.1
    移除 Beacon 设备更新事件的全部监听函数
    1.5.1
    监听 Beacon 服务状态变化事件,仅能注册一个监听
    1.5.1
    移除 Beacon 服务状态变化事件的全部监听函数
    1.5.1
    获取所有已搜索到的 Beacon 设备
    1.5.1
    Beacon 设备
    1.5.1

    14.5、NFC

    14.5.1、getNFCAdapter

    名称
    功能说明
    最低版本
    获取 NFC 实例
    1.5.0

    14.5.2、NFCAdapter

    名称
    功能说明
    最低版本
    开启设备
    1.5.0
    关闭设备
    1.5.0
    获取 Ndef 实例,实例支持对 NDEF 格式的 NFC 标签上的 NDEF 数据的读写
    1.5.0
    获取 NfcA 实例,实例支持NFC-A (ISO 14443-3A)标准的读写
    1.5.0
    获取 NfcB 实例,实例支持NFC-B (ISO 14443-3B)标准的读写
    1.5.0
    获取 NfcF 实例,实例支持NFC-F (JIS 6319-4)标准的读写
    1.5.0
    获取 NfcV 实例,实例支持NFC-V (ISO 15693)标准的读写
    1.5.0
    获取 IsoDep 实例,实例支持ISO-DEP (ISO 14443-4)标准的读写
    1.5.0
    获取 MifareClassic 实例,实例支持MIFARE Classic标签的读写
    1.5.0
    获取 MifareUltralight 实例,实例支持MIFARE Ultralight标签的读写
    1.5.0
    监听 NFC Tag
    1.5.0
    移除 NFC Tag的监听函数
    1.5.0

    14.5.3、IsoDep

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0
    获取复位信息
    1.5.0

    14.5.4、MifareClassic

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0

    14.5.5、MifareUltralifght

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0

    14.5.6、Ndef

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    取消监听 Ndef 消息
    1.5.0
    监听 Ndef 消息
    1.5.0
    重写 Ndef 标签内容
    1.5.0

    14.5.7、NfcA

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0
    获取 ATQA 信息
    1.5.0
    获取 SAK 信息
    1.5.0

    14.5.8、NfcB

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0

    14.5.9、NfcF

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0

    14.5.10、NfcV

    名称
    功能说明
    最低版本
    连接 NFC 标签
    1.5.0
    断开连接
    1.5.0
    设置超时时间
    1.5.0
    检查是否已连接
    1.5.0
    获取最大传输长度
    1.5.0
    发送数据
    1.5.0

    14.6、WiFi

    名称
    功能说明
    最低版本
    监听连接上 Wi-Fi 的事件
    1.5.1
    移除连接上 Wi-Fi 的事件的监听函数
    1.5.1
    stopWifi
    关闭 Wi-Fi 模块
    1.5.0
    startWifi
    初始化 Wi-Fi 模块
    1.5.0
    监听获取到 Wi-Fi 列表数据事件
    1.5.0
    移除获取到 Wi-Fi 列表数据事件的监听函数
    1.5.0
    获取已连接中的 Wi-Fi 信息
    1.5.0
    WifiInfo
    Wifi 信息
    1.5.1

    14.7、日历

    名称
    功能说明
    最低版本
    向系统日历添加重复事件
    1.5.1
    向系统日历添加事件
    1.5.1

    14.8、剪切板

    名称
    功能说明
    最低版本
    设置系统剪贴板的内容
    1.5.1
    获取系统剪贴板的内容
    1.5.1

    14.9、网络

    名称
    功能说明
    最低版本
    监听网络状态变化事件
    1.5.1
    获取网络类型
    1.5.1
    移除网络状态变化事件的监听函数
    1.5.1

    14.10、加密

    名称
    功能说明
    最低版本
    获取密码学安全随机数
    1.5.1

    14.11、键盘

    名称
    功能说明
    最低版本
    监听键盘高度变化事件
    1.5.1
    在input、textarea等 focus 拉起键盘之后,手动调用此接口收起键盘
    1.5.1
    移除键盘高度变化事件的监听函数
    1.5.1
    在input、textarea等 focus 之后,获取输入框的光标位置
    1.5.1

    14.12、电话

    名称
    
    功能说明
    最低版本
    
    拨打电话
    1.5.1

    14.13、加速计

    名称
    功能说明
    最低版本
    开始监听加速度数据
    1.5.1
    停止监听加速度数据
    1.5.1
    监听加速度数据事件
    1.5.1
    移除加速度数据事件的监听函数
    1.5.1

    14.14、罗盘

    名称
    功能说明
    最低版本
    开始监听罗盘数据
    1.5.0
    停止监听罗盘数据
    1.5.0
    监听罗盘数据变化事件
    1.5.0
    移除罗盘数据变化事件的监听函数
    1.5.0

    14.15、陀螺仪

    名称
    功能说明
    最低版本
    开始监听陀螺仪数据
    1.5.1
    停止监听陀螺仪数据
    1.5.1
    监听陀螺仪数据变化事件
    1.5.1
    移除陀螺仪数据变化事件的监听函数
    1.5.1

    14.16、扫码

    名称
    功能说明
    最低版本
    scanCode
    调起客户端扫码界面进行扫码
    1.5.0

    14.17、短信

    名称
    功能说明
    最低版本
    sendSms
    拉起手机发送短信界面
    1.5.1

    14.18、振动

    名称
    功能说明
    最低版本
    使手机发生较短时间的振动(15 ms)
    1.5.1
    使手机发生较长时间的振动(400 ms)
    1.5.1

    14.19、联系人

    名称
    功能说明
    最低版本
    拉起手机通讯录,选择联系人
    1.5.1
    添加手机通讯录联系人
    1.5.1

    14.20、电量

    名称
    功能说明
    最低版本
    wx.getBatteryInfo 的同步版本
    1.5.1
    获取设备电量
    1.5.1

    14.21、屏慕

    名称
    功能说明
    最低版本
    设置截屏/录屏时屏幕表现
    1.5.1
    设置屏幕亮度
    1.5.1
    设置是否保持常亮状态
    1.5.1
    监听用户主动截屏事件
    1.5.1
    监听用户录屏事件
    1.5.1
    用户主动截屏事件
    1.5.1
    移除用户录屏事件的监听函数
    1.5.1
    查询用户是否在录屏
    1.5.1
    获取屏幕亮度
    1.5.1

    14.22、设备方向

    名称
    功能说明
    最低版本
    停止监听设备方向的变化
    1.5.1
    开始监听设备方向的变化
    1.5.1
    监听设备方向变化事件
    1.5.1
    移除设备方向变化事件的监听函数
    1.5.1

    14.23、内存

    名称
    功能说明
    最低版本
    监听内存不足告警事件
    1.5.1
    移除内存不足告警事件的监听函数
    1.5.1

    14.24、无障碍

    名称
    功能说明
    最低版本
    检测是否开启视觉无障碍功能
    1.5.1
    

    15、WXML

    15.1、WXML 概要

    名称
    功能说明
    最低版本
    返回一个 SelectorQuery 对象实例
    1.5.0
    创建并返回一个 IntersectionObserver 对象实例
    1.5.0

    15.2、IntersectionObserve

    名称
    功能说明
    最低版本
    使用选择器指定一个节点,作为参照区域之一
    1.5.0
    指定页面显示区域作为参照区域之一
    1.5.0
    停止监听,回调函数将不再触发
    1.5.0
    指定目标节点并开始监听相交状态变化情况
    1.5.0

    15.3、NodesRef

    名称
    功能说明
    最低版本
    获取节点的相关信息
    1.5.0
    添加节点的布局位置的查询请求
    1.5.0
    添加节点的滚动位置查询请求
    1.5.0
    添加节点的 Context 对象查询请求
    1.5.0
    获取 Node 节点实例
    1.5.0

    15.4、SelectorQuery

    名称
    功能说明
    最低版本
    执行所有的请求
    1.5.0
    将选择器的选取范围更改为自定义组件 component 内
    1.5.0
    在当前页面下选择第一个匹配选择器 selector 的节点
    1.5.0
    在当前页面下选择匹配选择器 selector 的所有节点
    1.5.0
    选择显示区域
    1.5.0

    15.5、meidaQueryObserver

    名称
    功能说明
    最低版本
    停止监听
    1.5.16
    开始监听页面 media query 变化情况
    1.5.16
    

    16、自定义API

    名称
    功能说明
    最低版本
    自定义API
    1.5.0
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持