API 总览
优质
小牛编辑
136浏览
2023-12-01
基础
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.env | 环境变量 | 1.0.0 | |
ft.base64ToArrayBuffer | 将 Base64 字符串转成 ArrayBuffer 对象 | 1.0.0 | |
ft.arrayBufferToBase64 | 将 ArrayBuffer 对象转成 Base64 字符串 | 1.0.0 |
系统
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.getSystemInfoSync | wx.getSystemInfo 的同步版本 | 1.0.0 | |
ft.getSystemInfoAsync | 异步获取系统信息 | 1.0.0 | |
ft.getSystemInfo | 获取系统信息 | 1.0.0 |
更新
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.getUpdateManager | 获取全局唯一的版本更新管理器,用于管理小程序更新 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.updateWeChatApp | 更新客户端版本 |
小程序
生命周期
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.getLaunchOptionsSync | 获取小程序启动时的参数 | 1.0.0 | |
ft.getEnterOptionsSync | 获取本次小程序启动时的参数 | 1.0.0 |
应用级事件
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.onPageNotFound | 监听小程序要打开的页面不存在事件 | 1.0.0 | |
ft.onError | 监听小程序错误事件 | 1.0.0 | |
ft.onAppShow | 监听小程序切前台事件 | 1.0.0 | |
ft.onAppHide | 监听小程序切后台事件 | 1.0.0 | |
ft.offPageNotFound | 取消监听小程序要打开的页面不存在事件 | 1.0.0 | |
ft.offError | 取消监听小程序错误事件 | 1.0.0 | |
ft.offAppShow | 取消监听小程序切前台事件 | 1.0.0 | |
ft.offAppHide | 取消监听小程序切后台事件 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.onUnhandledRejection | 监听未处理的 Promise 拒绝事件 |
ft.onThemeChange | 监听系统主题改变事件 |
ft.onAudioInterruptionEnd | 监听音频中断结束事件 |
ft.onAudioInterruptionBegin | 监听音频因为受到系统占用而被中断开始事件 |
ft.offUnhandledRejection | 取消监听未处理的 Promise 拒绝事件 |
ft.offThemeChange | 取消监听系统主题改变事件 |
ft.offAudioInterruptionEnd | 取消监听音频中断结束事件 |
ft.offAudioInterruptionBegin | 取消监听音频因为受到系统占用而被中断开始事件 |
调试
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.setEnableDebug | 设置是否打开调试开关 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.getRealtimeLogManager | 获取实时日志管理器对象 |
ft.getLogManager | 获取日志管理器对象 |
性能
暂不支持
名称 | 功能说明 |
---|---|
ft.reportPerformance | 小程序测速上报 |
ft.getPerformance | 获取当前小程序性能相关的信息 |
加密
暂不支持
名称 | 功能说明 |
---|---|
ft.getUserCryptoManager | 获取用户加密模块 |
路由
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.switchTab | 跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面 | 1.0.0 | |
ft.reLaunch | 关闭所有页面,打开到应用内的某个页面 | 1.0.0 | |
ft.redirectTo | 关闭当前页面,跳转到应用内的某个页面 | 1.0.0 | |
ft.navigateTo | 保留当前页面,跳转到应用内的某个页面 | 1.0.0 | |
ft.navigateBack | 关闭当前页面,返回上一页面或多级页面 | 1.0.0 |
跳转
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.navigateToMiniProgram | 打开另一个小程序 | 1.0.0 | |
ft.navigateBackMiniProgram | 返回到上一个小程序 | 1.0.0 | |
ft.exitMiniProgram | 退出当前小程序 | 1.0.0 |
转发
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.showShareMenu | 显示当前页面的转发按钮 | 1.0.0 | |
ft.hideShareMenu | 隐藏当前页面的转发按钮 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.updateShareMenu | 更新转发属性 |
ft.showShareImageMenu | 打开分享图片弹窗,可以将图片发送给朋友、收藏或下载 |
ft.shareVideoMessage | 转发视频到聊天 |
ft.shareFileMessage | 转发文件到聊天 |
ft.onCopyUrl | 监听用户点击右上角菜单的「复制链接」按钮时触发的事件 |
ft.offCopyUrl | 取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件 |
ft.getShareInfo | 获取转发详细信息 |
ft.authPrivateMessage | 验证私密消息 |
界面
交互
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.showToast | 显示消息提示框 | 1.0.0 | |
ft.showModal | 显示模态对话框 | 1.0.0 | |
ft.showLoading | 显示 loading 提示框 | 1.0.0 | |
ft.showActionSheet | 显示操作菜单 | 1.0.0 | |
ft.hideToast | 隐藏消息提示框 | 1.0.0 | |
ft.hideLoading | 隐藏 loading 提示框 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.enableAlertBeforeUnload | 开启小程序页面返回询问对话框 |
ft.disableAlertBeforeUnload | 关闭小程序页面返回询问对话框 |
导航栏
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.showNavigationBarLoading | 在当前页面显示导航条加载动画 | 1.0.0 | |
ft.setNavigationBarTitle | 动态设置当前页面的标题 | 1.0.0 | |
ft.setNavigationBarColor | 设置页面导航条颜色 | 1.0.0 | |
ft.hideNavigationBarLoading | 在当前页面隐藏导航条加载动画 | 1.0.0 | |
ft.hideHomeButton | 隐藏返回首页按钮 | 1.0.0 |
背景
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.setBackgroundTextStyle | 动态设置下拉背景字体、loading 图的样式 | 1.0.0 | |
ft.setBackgroundColor | 动态设置窗口的背景色 | 1.0.0 |
Tab Bar
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.showTabBarRedDot | 显示 tabBar 某一项的右上角的红点 | 1.0.0 | |
ft.showTabBar | 显示 tabBar | 1.0.0 | |
ft.setTabBarStyle | 动态设置 tabBar 的整体样式 | 1.0.0 | |
ft.setTabBarItem | 动态设置 tabBar 某一项的内容,2.7.0 起图片支持临时文件和网络文件 | 1.0.0 | |
ft.setTabBarBadge | 为 tabBar 某一项的右上角添加文本 | 1.0.0 | |
ft.removeTabBarBadge | 移除 tabBar 某一项右上角的文本 | 1.0.0 | |
ft.hideTabBarRedDot | 隐藏 tabBar 某一项的右上角的红点 | 1.0.0 | |
ft.hideTabBar | 隐藏 tabBar | 1.0.0 |
字体
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.loadFontFace | 动态加载网络字体,文件地址需为下载类型 | 1.0.0 |
下拉刷新
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopPullDownRefresh | 停止当前页面下拉刷新 | 1.0.0 | |
ft.startPullDownRefresh | 开始下拉刷新 | 1.0.0 |
滚动
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.pageScrollTo | 将页面滚动到目标位置,支持选择器和滚动距离两种方式定位 | 1.0.0 |
动画
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createAnimation | 创建一个动画实例 animation | 1.0.0 |
置顶
暂不支持
名称 | 功能说明 |
---|---|
ft.setTopBarText | 动态设置置顶栏文字内容 |
自定义组件
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.nextTick | 延迟一部分操作到下一个时间片再执行 | 1.0.0 |
菜单
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.getMenuButtonBoundingClientRect | 获取菜单按钮(右上角胶囊按钮)的布局位置信息 | 1.0.0 |
窗口
暂不支持
名称 | 功能说明 |
---|---|
ft.setWindowSize | 设置窗口大小,该接口仅适用于 PC 平台,使用细则请参见指南 |
ft.onWindowResize | 监听窗口尺寸变化事件 |
ft.offWindowResize | 取消监听窗口尺寸变化事件 |
网络
发起请求
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.request | 发起 HTTPS 网络请求 | 1.0.0 |
下载
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.downloadFile | 下载文件资源到本地 | 1.0.0 |
上传
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.uploadFile | 将本地资源上传到服务器 | 1.0.0 |
WebSocket
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.sendSocketMessage | 通过 WebSocket 连接发送数据 | 1.0.0 | |
ft.onSocketOpen | 监听 WebSocket 连接打开事件 | 1.0.0 | |
ft.onSocketMessage | 监听 WebSocket 接受到服务器的消息事件 | 1.0.0 | |
ft.onSocketError | 监听 WebSocket 错误事件 | 1.0.0 | |
ft.onSocketClose | 监听 WebSocket 连接关闭事件 | 1.0.0 | |
ft.connectSocket | 创建一个 WebSocket 连接 | 1.0.0 | |
ft.closeSocket | 关闭 WebSocket 连接 | 1.0.0 |
mDNS
暂不支持
名称 | 功能说明 |
---|---|
ft.stopLocalServiceDiscovery | 停止搜索 mDNS 服务 |
ft.startLocalServiceDiscovery | 开始搜索局域网下的 mDNS 服务 |
ft.onLocalServiceResolveFail | 监听 mDNS 服务解析失败的事件 |
ft.onLocalServiceLost | 监听 mDNS 服务离开的事件 |
ft.onLocalServiceFound | 监听 mDNS 服务发现的事件 |
ft.onLocalServiceDiscoveryStop | 监听 mDNS 服务停止搜索的事件 |
ft.offLocalServiceResolveFail | 取消监听 mDNS 服务解析失败的事件 |
ft.offLocalServiceLost | 取消监听 mDNS 服务离开的事件 |
ft.offLocalServiceFound | 取消监听 mDNS 服务发现的事件 |
ft.offLocalServiceDiscoveryStop | 取消监听 mDNS 服务停止搜索的事件 |
TCP 通信
暂不支持
名称 | 功能说明 |
---|---|
ft.createTCPSocket | 创建一个 TCP Socket 实例 |
UDP 通信
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createUDPSocket | 创建一个 UDP Socket 实例 | 1.0.0 |
支付
暂不支持
名称 | 功能说明 |
---|---|
ft.requestPayment | 发起微信支付 |
ft.requestOrderPayment | 创建自定义版交易组件订单,并发起支付 |
数据缓存
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.setStorageSync | wx.setStorage 的同步版本 | 1.0.0 | |
ft.setStorage | 将数据存储在本地缓存中指定的 key 中 | 1.0.0 | |
ft.removeStorageSync | wx.removeStorage 的同步版本 | 1.0.0 | |
ft.removeStorage | 从本地缓存中移除指定 key | 1.0.0 | |
ft.getStorageSync | wx.getStorage 的同步版本 | 1.0.0 | |
ft.getStorageInfoSync | wx.getStorageInfo 的同步版本 | 1.0.0 | |
ft.getStorageInfo | 异步获取当前storage的相关信息 | 1.0.0 | |
ft.getStorage | 从本地缓存中异步获取指定 key 的内容 | 1.0.0 | |
ft.clearStorageSync | wx.clearStorage 的同步版本 | 1.0.0 | |
ft.clearStorage | 清理本地数据缓存 | 1.0.0 |
暂不支持
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.revokeBufferURL | 根据 URL 销毁存在内存中的数据 | 1.0.0 | |
ft.createBufferURL | 根据传入的 buffer 创建一个唯一的 URL 存在内存中 | 1.0.0 |
周期性更新
暂不支持
名称 | 功能说明 |
---|---|
ft.setBackgroundFetchToken | 设置自定义登录态,在周期性拉取数据时带上,便于第三方服务器验证请求合法性 |
ft.onBackgroundFetchData | 监听收到 backgroundFetch 数据时的回调 |
ft.getBackgroundFetchToken | 获取设置过的自定义登录态 |
ft.getBackgroundFetchData | 拉取 backgroundFetch 客户端缓存数据 |
数据分析
暂不支持
名称 | 功能说明 |
---|---|
ft.reportMonitor | 自定义业务数据监控上报接口 |
ft.reportEvent | 事件上报 |
ft.reportAnalytics | 自定义分析数据上报接口 |
ft.getExptInfoSync | 给定实验参数数组,获取对应的实验参数值 |
画布
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createCanvasContext | 创建 canvas 的绘图上下文 CanvasContext 对象 | 1.0.0 | |
ft.canvasToTempFilePath | 把当前画布指定区域的内容导出生成指定大小的图片 | 1.0.0 | |
ft.canvasPutImageData | 将像素数据绘制到画布 | 1.0.0 | |
ft.canvasGetImageData | 获取 canvas 区域隐含的像素数据 | 1.0.0 |
暂不支持
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createOffscreenCanvas | 创建离屏 canvas 实例 | 1.0.0 |
媒体
地图
暂不支持
名称 | 功能说明 |
---|---|
ft.createMapContext | 创建 map 上下文 MapContext 对象 |
图片
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.saveImageToPhotosAlbum | 保存图片到系统相册 | 1.0.0 | |
ft.previewMedia | 预览图片和视频 | 1.0.0 | |
ft.previewImage | 在新页面中全屏预览图片 | 1.0.0 | |
ft.getImageInfo | 获取图片信息 | 1.0.0 | |
ft.compressImage | 压缩图片接口,可选压缩质量 | 1.0.0 | |
ft.chooseMessageFile | 从客户端会话选择文件 | 1.0.0 | |
ft.chooseImage | 从本地相册选择图片或使用相机拍照 | 1.0.0 |
视频
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.saveVideoToPhotosAlbum | 保存视频到系统相册 | 1.0.0 | |
ft.createVideoContext | 创建 video 上下文 VideoContext 对象 | 1.0.0 | |
ft.chooseVideo | 拍摄视频或从手机相册中选视频 | 1.0.0 | |
ft.chooseMedia | 拍摄或从手机相册中选择图片或视频 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.openVideoEditor | 打开视频编辑器 |
ft.getVideoInfo | 获取视频详细信息 |
ft.compressVideo | 压缩视频接口 |
音频
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopVoice | 结束播放语音 | 1.0.0 | |
ft.setInnerAudioOption | 设置 InnerAudioContext 的播放选项 | 1.0.0 | |
ft.playVoice | 开始播放语音 | 1.0.0 | |
ft.pauseVoice | 暂停正在播放的语音 | 1.0.0 | |
ft.createInnerAudioContext | 创建内部 audio 上下文 InnerAudioContext 对象 | 1.0.0 | |
ft.createAudioContext | 创建 audio 上下文 AudioContext 对象 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.getAvailableAudioSources | 获取当前支持的音频输入源 |
ft.createWebAudioContext | 创建WebAudio上下文 |
ft.createMediaAudioPlayer | 创建媒体音频播放器对象 MediaAudioPlayer 对象,可用于播放视频解码器 VideoDecoder 输出的音频 |
实时音视频
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createLivePusherContext | 创建 live-pusher 上下文 LivePusherContext 对象 | 1.0.0 | |
ft.createLivePlayerContext | 创建 live-player 上下文 LivePlayerContext 对象 | 1.0.0 |
录音
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopRecord | 停止录音 | 1.0.0 | |
ft.startRecord | 开始录音 | 1.0.0 | |
ft.getRecorderManager | 获取全局唯一的录音管理器 RecorderManager | 1.0.0 |
相机
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createCameraContext | 创建 camera 上下文 CameraContext 对象 | 1.0.0 |
富文本
EditorContext
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
EditorContext.blur | 编辑器失焦,同时收起键盘 | 1.0.0 | |
EditorContext.clear | 清空编辑器内容 | 1.0.0 | |
EditorContext.format | 修改样式 | 1.0.0 | |
EditorContext.getContents | 获取编辑器内容 | 1.0.0 | |
EditorContext.getSelectionText | 获取编辑器已选区域内的纯文本内容 | 1.0.0 | |
EditorContext.insertDivider | 插入分割线 | 1.0.0 | |
EditorContext.insertImage | 插入图片 | 1.0.0 | |
EditorContext.insertText | 覆盖当前选区,设置一段文本 | 1.0.0 | |
EditorContext.redo | 恢复 | 1.0.0 | |
EditorContext.removeFormat | 清除当前选区的样式 | 1.0.0 | |
EditorContext.scrollIntoView | 使得编辑器光标处滚动到窗口可视区域内 | 1.0.0 | |
EditorContext.setContents | 初始化编辑器内容,html和delta同时存在时仅delta生效 | 1.0.0 | |
EditorContext.undo | 撤销 | 1.0.0 |
音视频合成
暂不支持
名称 | 功能说明 |
---|---|
ft.createMediaContainer | 创建音视频处理容器,最终可将容器中的轨道合成一个视频 |
实时语音
暂不支持
名称 | 功能说明 |
---|---|
ft.updateVoIPChatMuteConfig | 更新实时语音静音设置 |
ft.subscribeVoIPVideoMembers | 订阅视频画面成员 |
ft.onVoIPVideoMembersChanged | 监听实时语音通话成员视频状态变化事件 |
ft.onVoIPChatStateChanged | 监听房间状态变化事件 |
ft.onVoIPChatSpeakersChanged | 监听实时语音通话成员通话状态变化事件 |
ft.onVoIPChatMembersChanged | 监听实时语音通话成员在线状态变化事件 |
ft.onVoIPChatInterrupted | 监听被动断开实时语音通话事件 |
ft.offVoIPVideoMembersChanged | 取消监听实时语音通话成员视频状态变化事件 |
ft.offVoIPChatStateChanged | 取消监听房间状态变化事件 |
ft.offVoIPChatMembersChanged | 取消监听实时语音通话成员在线状态变化事件 |
ft.offVoIPChatInterrupted | 取消监听被动断开实时语音通话事件 |
ft.joinVoIPChat | 加入 (创建) 实时语音通话,更多信息可见 实时语音指南 |
ft.exitVoIPChat | 退出(销毁)实时语音通话 |
画面录制器
暂不支持
名称 | 功能说明 |
---|---|
ft.createMediaRecorder | 创建 WebGL 画面录制器,可逐帧录制在 WebGL 上渲染的画面并导出视频文件 |
视频解码器
暂不支持
名称 | 功能说明 |
---|---|
ft.createVideoDecoder | 创建视频解码器,可逐帧获取解码后的数据 |
位置
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.openLocation | 使用微信内置地图查看位置 | 1.0.0 | |
ft.getLocation | 获取当前的地理位置、速度 | 1.0.0 | |
ft.chooseLocation | 打开地图选择位置 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.stopLocationUpdate | 关闭监听实时位置变化,前后台都停止消息接收 |
ft.startLocationUpdateBackground | 开启小程序进入前后台时均接收位置消息,需引导用户开启授权 |
ft.startLocationUpdate | 开启小程序进入前台时接收位置消息 |
ft.onLocationChange | 监听实时地理位置变化事件,需结合 wx.startLocationUpdateBackground、wx.startLocationUpdate使用 |
ft.offLocationChange | 取消监听实时地理位置变化事件 |
ft.choosePoi | 打开地图选择位置,支持模糊定位(精确到市)和精确定位混选 |
文件
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.saveFile | 保存文件到本地 | 1.0.0 | |
ft.removeSavedFile | 删除本地缓存文件 | 1.0.0 | |
ft.openDocument | 新开页面打开文档 | 1.0.0 | |
ft.getSavedFileList | 获取该小程序下已保存的本地缓存文件列表 | 1.0.0 | |
ft.getSavedFileInfo | 获取本地文件的文件信息 | 1.0.0 | |
ft.getFileSystemManager | 获取全局唯一的文件管理器 | 1.0.0 | |
ft.getFileInfo | 获取文件信息 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
ft.saveFileToDisk | 保存文件系统的文件到用户磁盘,仅在 PC 端支持 |
开放接口
登录
暂不支持
名称 | 功能说明 |
---|---|
ft.login | 调用接口获取登录凭证(code) |
ft.checkSession | 检查登录态是否过期 |
帐号信息
暂不支持
名称 | 功能说明 |
---|---|
ft.getAccountInfoSync | 获取当前帐号信息 |
用户信息
暂不支持
名称 | 功能说明 |
---|---|
ft.getUserProfile | 获取用户信息 |
ft.getUserInfo | 获取用户信息 |
UserInfo | 用户信息 |
授权
暂不支持
名称 | 功能说明 |
---|---|
ft.authorizeForMiniProgram | 仅小程序插件中能调用该接口,用法同 wx.authorize |
ft.authorize | 提前向用户发起授权请求 |
设置
暂不支持
名称 | 功能说明 |
---|---|
ft.openSetting | 调起客户端小程序设置界面,返回用户设置的操作结果 |
ft.getSetting | 获取用户的当前设置 |
AuthSetting | 用户授权设置信息,详情参考权限 |
SubscriptionsSetting | 订阅消息设置 |
收货地址
暂不支持
名称 | 功能说明 |
---|---|
ft.chooseAddress | 获取用户收货地址 |
卡券
暂不支持
名称 | 功能说明 |
---|---|
ft.openCard | 查看微信卡包中的卡券 |
ft.addCard | 批量添加卡券 |
发票
暂不支持
名称 | 功能说明 |
---|---|
ft.chooseInvoiceTitle | 选择用户的发票抬头 |
ft.chooseInvoice | 选择用户已有的发票 |
生物认证
暂不支持
名称 | 功能说明 |
---|---|
ft.startSoterAuthentication | 开始 SOTER 生物认证 |
ft.checkIsSupportSoterAuthentication | 获取本机支持的 SOTER 生物认证方式 |
ft.checkIsSoterEnrolledInDevice | 获取设备内是否录入如指纹等生物信息的接口 |
微信运动
暂不支持
名称 | 功能说明 |
---|---|
ft.shareToWeRun | 分享数据到微信运动 |
ft.getWeRunData | 获取用户过去三十天微信运动步数 |
订阅消息
暂不支持
名称 | 功能说明 |
---|---|
ft.requestSubscribeMessage | 调起客户端小程序订阅消息界面,返回用户订阅消息的操作结果 |
微信红包
暂不支持
名称 | 功能说明 |
---|---|
ft.showRedPackage | 拉取h5领取红包封面页 |
收藏
暂不支持
名称 | 功能说明 |
---|---|
ft.addVideoToFavorites | 收藏视频 |
ft.addFileToFavorites | 收藏文件 |
车牌
暂不支持
名称 | 功能说明 |
---|---|
ft.chooseLicensePlate | 选择车牌号 |
视频号
暂不支持
名称 | 功能说明 |
---|---|
ft.reserveChannelsLive | 预约视频号直播 |
ft.openChannelsLive | 打开视频号直播 |
ft.openChannelsActivity | 打开视频号视频 |
ft.getChannelsLiveNoticeInfo | 获取视频号直播预告信息 |
ft.getChannelsLiveInfo | 获取视频号直播信息 |
微信群
暂不支持
名称 | 功能说明 |
---|---|
ft.getGroupEnterInfo | 获取微信群聊场景下的小程序启动信息 |
微信客服
暂不支持
名称 | 功能说明 |
---|---|
ft.openCustomerServiceChat | 打开微信客服 |
设备
蓝牙-通用
暂不支持
名称 | 功能说明 |
---|---|
ft.stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备 |
ft.startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备 |
ft.openBluetoothAdapter | 初始化蓝牙模块 |
ft.onBluetoothDeviceFound | 监听搜索到新设备的事件 |
ft.onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化事件 |
ft.offBluetoothDeviceFound | 取消监听寻找到新设备的事件 |
ft.offBluetoothAdapterStateChange | 取消监听蓝牙适配器状态变化事件 |
ft.makeBluetoothPair | 蓝牙配对接口,仅安卓支持 |
ft.getConnectedBluetoothDevices | 根据主服务 UUID 获取已连接的蓝牙设备 |
ft.getBluetoothDevices | 获取在蓝牙模块生效期间所有搜索到的蓝牙设备 |
ft.getBluetoothAdapterState | 获取本机蓝牙适配器状态 |
ft.closeBluetoothAdapter | 关闭蓝牙模块 |
蓝牙-低功耗中心设备
暂不支持
名称 | 功能说明 |
---|---|
ft.writeBLECharacteristicValue | 向蓝牙低功耗设备特征值中写入二进制数据 |
ft.setBLEMTU | 协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU) |
ft.readBLECharacteristicValue | 读取蓝牙低功耗设备特征值的二进制数据 |
ft.onBLEConnectionStateChange | 监听蓝牙低功耗连接状态的改变事件 |
ft.onBLECharacteristicValueChange | 监听蓝牙低功耗设备的特征值变化事件 |
ft.offBLEConnectionStateChange | 取消监听蓝牙低功耗连接状态的改变事件 |
ft.offBLECharacteristicValueChange | 取消监听蓝牙低功耗设备的特征值变化事件 |
ft.notifyBLECharacteristicValueChange | 启用蓝牙低功耗设备特征值变化时的 notify 功能,订阅特征 |
ft.getBLEDeviceServices | 获取蓝牙低功耗设备所有服务 (service) |
ft.getBLEDeviceRSSI | 获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI) |
ft.getBLEDeviceCharacteristics | 获取蓝牙低功耗设备某个服务中所有特征 (characteristic) |
ft.createBLEConnection | 连接蓝牙低功耗设备 |
ft.closeBLEConnection | 断开与蓝牙低功耗设备的连接 |
蓝牙-低功耗外围设备
暂不支持
名称 | 功能说明 |
---|---|
ft.onBLEPeripheralConnectionStateChanged | 监听当前外围设备被连接或断开连接事件 |
ft.offBLEPeripheralConnectionStateChanged | 取消监听当前外围设备被连接或断开连接事件 |
ft.createBLEPeripheralServer | 建立本地作为蓝牙低功耗外围设备的服务端,可创建多个 |
蓝牙-信标(Beacon)
暂不支持
名称 | 功能说明 |
---|---|
ft.stopBeaconDiscovery | 停止搜索附近的 Beacon 设备 |
ft.startBeaconDiscovery | 开始搜索附近的 Beacon 设备 |
ft.onBeaconUpdate | 监听 Beacon 设备更新事件,仅能注册一个监听 |
ft.onBeaconServiceChange | 监听 Beacon 服务状态变化事件,仅能注册一个监听 |
ft.offBeaconUpdate | 取消监听 Beacon 设备更新事件 |
ft.offBeaconServiceChange | 取消监听 Beacon 服务状态变化事件 |
ft.getBeacons | 获取所有已搜索到的 Beacon 设备 |
BeaconInfo |
NFC
暂不支持
名称 | 功能说明 |
---|---|
ft.stopHCE | 关闭 NFC 模块 |
ft.startHCE | 初始化 NFC 模块 |
ft.sendHCEMessage | 发送 NFC 消息 |
ft.onHCEMessage | 监听接收 NFC 设备消息事件,仅能注册一个监听 |
ft.offHCEMessage | 接收 NFC 设备消息事件,取消事件监听 |
ft.getNFCAdapter | 获取 NFC 实例 |
ft.getHCEState | 判断当前设备是否支持 HCE 能力 |
Wi-Fi
暂不支持
名称 | 功能说明 |
---|---|
ft.stopWifi | 关闭 Wi-Fi 模块 |
ft.startWifi | 初始化 Wi-Fi 模块 |
ft.setWifiList | 设置 wifiList 中 AP 的相关信息 |
ft.onWifiConnected | 监听连接上 Wi-Fi 的事件 |
ft.onGetWifiList | 监听获取到 Wi-Fi 列表数据事件 |
ft.offWifiConnected | 取消监听连接上 Wi-Fi 的事件 |
ft.offGetWifiList | 取消监听获取到 Wi-Fi 列表数据事件 |
ft.getWifiList | 请求获取 Wi-Fi 列表 |
ft.getConnectedWifi | 获取已连接中的 Wi-Fi 信息 |
ft.connectWifi | 连接 Wi-Fi |
WifiInfo | Wifi 信息 |
日历
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.addPhoneRepeatCalendar | 向系统日历添加重复事件 | 1.0.0 | |
ft.addPhoneCalendar | 向系统日历添加事件 | 1.0.0 |
联系人
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.searchContacts | 查找通讯录,匹配相近的手机号 | 1.0.0 | |
ft.chooseContact | 拉起手机通讯录,选择联系人 | 1.0.0 | |
ft.addPhoneContact | 添加手机通讯录联系人 | 1.0.0 |
无障碍
暂不支持
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.checkIsOpenAccessibility | 检测是否开启视觉无障碍功能 | 1.0.0 |
电量
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.getBatteryInfoSync | wx.getBatteryInfo 的同步版本 | 1.0.0 | |
ft.getBatteryInfo | 获取设备电量 | 1.0.0 |
剪贴板
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.setClipboardData | 设置系统剪贴板的内容 | 1.0.0 | |
ft.getClipboardData | 获取系统剪贴板的内容 | 1.0.0 |
网络
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.onNetworkStatusChange | 监听网络状态变化事件 | 1.0.0 | |
ft.offNetworkStatusChange | 取消监听网络状态变化事件,参数为空,则取消所有的事件监听 | 1.0.0 | |
ft.getNetworkType | 获取网络类型 | 1.0.0 |
加密
暂不支持
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.getRandomValues | 获取密码学安全随机数 | 1.0.0 |
屏幕
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.setScreenBrightness | 设置屏幕亮度 | 1.0.0 | |
ft.setKeepScreenOn | 设置是否保持常亮状态 | 1.0.0 | |
ft.onUserCaptureScreen | 监听用户主动截屏事件 | 1.0.0 | |
ft.offUserCaptureScreen | 用户主动截屏事件 | 1.0.0 | |
ft.getScreenBrightness | 获取屏幕亮度 | 1.0.0 |
键盘
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.onKeyboardHeightChange | 监听键盘高度变化 | 1.0.0 | |
ft.offKeyboardHeightChange | 取消监听键盘高度变化事件 | 1.0.0 | |
ft.hideKeyboard | 在input、textarea等focus拉起键盘之后,手动调用此接口收起键盘 | 1.0.0 | |
ft.getSelectedTextRange | 在input、textarea等focus之后,获取输入框的光标位置 | 1.0.0 |
电话
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.makePhoneCall | 拨打电话 | 1.0.0 |
加速计
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopAccelerometer | 停止监听加速度数据 | 1.0.0 | |
ft.startAccelerometer | 开始监听加速度数据 | 1.0.0 | |
ft.onAccelerometerChange | 监听加速度数据事件 | 1.0.0 | |
ft.offAccelerometerChange | 取消监听加速度数据事件,参数为空,则取消所有的事件监听 | 1.0.0 |
罗盘
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopCompass | 停止监听罗盘数据 | 1.0.0 | |
ft.startCompass | 开始监听罗盘数据 | 1.0.0 | |
ft.onCompassChange | 监听罗盘数据变化事件 | 1.0.0 | |
ft.offCompassChange | 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听 | 1.0.0 |
设备方向
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopDeviceMotionListening | 停止监听设备方向的变化 | 1.0.0 | |
ft.startDeviceMotionListening | 开始监听设备方向的变化 | 1.0.0 | |
ft.onDeviceMotionChange | 监听设备方向变化事件 | 1.0.0 | |
ft.offDeviceMotionChange | 取消监听设备方向变化事件,参数为空,则取消所有的事件监听 | 1.0.0 |
陀螺仪
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.stopGyroscope | 停止监听陀螺仪数据 | 1.0.0 | |
ft.startGyroscope | 开始监听陀螺仪数据 | 1.0.0 | |
ft.onGyroscopeChange | 监听陀螺仪数据变化事件 | 1.0.0 | |
ft.offGyroscopeChange | 取消监听陀螺仪数据变化事件 | 1.0.0 |
内存
暂不支持
名称 | 功能说明 |
---|---|
ft.onMemoryWarning | 监听内存不足告警事件 |
ft.offMemoryWarning | 取消监听内存不足告警事件 |
扫码
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.scanCode | 调起客户端扫码界面进行扫码 | 1.0.0 |
振动
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.vibrateShort | 使手机发生较短时间的振动(15 ms) | 1.0.0 | |
ft.vibrateLong | 使手机发生较长时间的振动(400 ms) | 1.0.0 |
AI/人脸识别
暂不支持
名称 | 功能说明 |
---|---|
ft.stopFaceDetect | 停止人脸识别 |
ft.initFaceDetect | 初始化人脸识别 |
ft.faceDetect | 人脸识别,使用前需要通过 wx.initFaceDetect 进行一次初始化,推荐使用相机接口返回的帧数据 |
Worker
暂不支持
名称 | 功能说明 |
---|---|
ft.createWorker | 创建一个 Worker 线程 |
WXML
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
ft.createSelectorQuery | 返回一个 SelectorQuery 对象实例 | 1.0.0 | |
ft.createIntersectionObserver | 创建并返回一个 IntersectionObserver 对象实例 | 1.0.0 |
IntersectionObserver
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
IntersectionObserver.disconnect | 停止监听 | 1.0.0 | |
IntersectionObserver.observe | 指定目标节点并开始监听相交状态变化情况 | 1.0.0 | |
IntersectionObserver.relativeTo | 使用选择器指定一个节点,作为参照区域之一 | 1.0.0 | |
IntersectionObserver.relativeToViewport | 指定页面显示区域作为参照区域之一 | 1.0.0 |
MediaQueryObserver
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
MediaQueryObserver.disconnect | 停止监听 | 1.0.0 | |
MediaQueryObserver.observe | 开始监听页面 media query 变化情况 | 1.0.0 |
NodesRef
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
NodesRef.boundingClientRect | 添加节点的布局位置的查询请求 | 1.0.0 | |
NodesRef.context | 添加节点的 Context 对象查询请求 | 1.0.0 | |
NodesRef.fields | 获取节点的相关信息 | 1.0.0 | |
NodesRef.scrollOffset | 添加节点的滚动位置查询请求 | 1.0.0 |
暂不支持
名称 | 功能说明 |
---|---|
NodesRef.node | 获取 Node 节点实例 |
SelectorQuery
名称 | 功能说明 | 版本 | 备注 |
---|---|---|---|
SelectorQuery.exec | 执行所有的请求 | 1.0.0 | |
SelectorQuery.in | 将选择器的选取范围更改为自定义组件 component 内 | 1.0.0 | |
SelectorQuery.select | 在当前页面下选择第一个匹配选择器 selector 的节点 | 1.0.0 | |
SelectorQuery.selectAll | 在当前页面下选择匹配选择器 selector 的所有节点 | 1.0.0 | |
SelectorQuery.selectViewport | 选择显示区域 | 1.0.0 |
第三方平台
暂不支持
名称 | 功能说明 |
---|---|
ft.getExtConfigSync | wx.getExtConfig 的同步版本 |
ft.getExtConfig | 获取第三方平台自定义的数据字段 |
广告
暂不支持
名称 | 功能说明 |
---|---|
ft.createRewardedVideoAd | 创建激励视频广告组件 |
ft.createInterstitialAd | 创建插屏广告组件 |