小程序API基础说明

网友投稿 511 2024-07-07 09:38:48

基础

名称功能说明版本备注
ft.env环境变量1.0.0
ft.canIUse判断小程序的API，回调，参数，组件等是否在当前版本可用1.0.0
ft.base64ToArrayBuffer将 Base64 字符串转成 ArrayBuffer 对象1.0.0
ft.arrayBufferToBase64将 ArrayBuffer 对象转成 Base64 字符串1.0.0
ft.base64ToTempFilePath将图片的base64数据保存到本地沙盒，并返回本地缓存路径1.0.0
ft.fileToBase64将文件转换为 Base64 字符串1.0.0

#1.1 系统

名称功能说明版本备注
ft.getSystemInfoSyncft.getSystemInfo 的同步版本1.0.0
ft.getSystemInfoAsync异步获取系统信息1.0.0
ft.getSystemInfo获取系统信息1.0.0
ft.openSystemBluetoothSetting跳转系统蓝牙设置页3.0.45
ft.openAppAuthorizeSetting跳转系统授权管理页3.0.45
ft.getWindowInfo获取窗口信息3.0.45
ft.getSystemSetting获取设备设置3.0.45
ft.getRendererUserAgent获取 Webview 小程序的 UserAgent3.0.45
ft.getDeviceInfo获取设备基础信息3.0.45
ft.getAppBaseInfo获取APP基础信息3.0.45
ft.getAppAuthorizeSetting获取APP授权设置3.0.45

请注意

以下 API 暂未支持

名称功能说明
ft.getSkylineInfoSyncft.getSkylineInfo 的同步版本
ft.getSkylineInfo获取当前运行环境对于 Skyline 渲染引擎 的支持情况

#1.2 更新

名称功能说明版本备注
ft.getUpdateManager获取全局唯一的版本更新管理器，用于管理小程序更新1.0.0

请注意

以下 API 暂未支持

名称功能说明
ft.updateWeChatApp更新客户端版本

#1.2.1 UpdateManager

名称功能说明版本备注
UpdateManager.applyUpdate强制小程序重启并使用新版本1.0.0
UpdateManager.onCheckForUpdate监听向微信后台请求检查更新结果事件1.0.0
UpdateManager.onUpdateFailed监听小程序更新失败事件1.0.0
UpdateManager.onUpdateReady监听小程序有版本更新事件1.0.0

#1.3 小程序

#1.3.1 生命周期

名称功能说明版本备注
ft.getLaunchOptionsSync获取小程序启动时的参数1.0.0
ft.getEnterOptionsSync获取本次小程序启动时的参数1.0.0

#1.3.2 应用级事件

名称功能说明版本备注
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.onThemeChange监听系统主题改变事件1.0.0
ft.onUnhandledRejection监听未处理的 Promise 拒绝事件1.0.0
ft.offUnhandledRejection取消监听未处理的 Promise 拒绝事件1.0.0
ft.offThemeChange取消监听系统主题改变事件1.0.0

请注意

以下 API 暂未支持

名称功能说明
ft.onAudioInterruptionEnd监听音频中断结束事件
ft.onAudioInterruptionBegin监听音频因为受到系统占用而被中断开始事件
ft.offAudioInterruptionEnd取消监听音频中断结束事件
ft.offAudioInterruptionBegin取消监听音频因为受到系统占用而被中断开始事件
ft.onLazyLoadError监听应用异步组件加载失败回调
ft.offLazyLoadError取消监听应用异步组件加载失败回调

#1.4 调试

名称功能说明版本备注
ft.setEnableDebug设置是否打开调试开关1.0.0

请注意

以下 API 暂未支持

名称功能说明
ft.getRealtimeLogManager获取实时日志管理器对象
ft.getLogManager获取日志管理器对象

#1.4.1 console

名称功能说明版本备注
console.debug向调试面板中打印 debug 日志1.0.0
console.error向调试面板中打印 error 日志1.0.0
console.group在调试面板中创建一个新的分组1.0.0
console.groupEnd结束由 console.group 创建的分组1.0.0
console.info向调试面板中打印 info 日志1.0.0
console.log向调试面板中打印 log 日志1.0.0
console.warn向调试面板中打印 warn 日志1.0.0

#1.4.2 LogManager

名称功能说明版本备注
LogManager.debug写 debug 日志是，但日志只在本地 console3.0.36
LogManager.info写 info 日志是，但日志只在本地 console3.0.36
LogManager.log写 log 日志是，但日志只在本地 console3.0.36
LogManager.warn写 warn 日志是，但日志只在本地 console3.0.36

#1.4.3 RealtimeLogManager

名称功能说明版本备注
RealtimeLogManager.error写 error 日志是，但日志只在本地 console3.0.36
RealtimeLogManager.info写 info 日志是，但日志只在本地 console3.0.36
RealtimeLogManager.warn写 warn 日志是，但日志只在本地 console3.0.36
RealtimeLogManager.setFilterMsg设置过滤关键字是，但日志只在本地 console3.0.36
RealtimeLogManager.addFilterMsg添加过滤关键字是，但日志只在本地 console3.0.36

请注意

以下 API 暂未支持

名称功能说明
RealtimeLogManager.getCurrentState实时日志会将一定时间间隔内缓存的日志聚合上报，如果该时间内缓存的内容超出限制，则会被丢弃
RealtimeLogManager.in设置实时日志page参数所在的页面
RealtimeLogManager.tag获取给定标签的日志管理器实例

#1.4.4 RealtimeTagLogManager

请注意

以下 API 暂未支持

名称功能说明
RealtimeTagLogManager.info写 info 日志
RealtimeTagLogManager.warn写 warn 日志
RealtimeTagLogManager.error写 error 日志
RealtimeTagLogManager.insetFilterMsgfo设置过滤关键字
RealtimeTagLogManager.addFilterMsg添加过滤关键字

#1.5 性能

请注意

以下 API 暂未支持

名称功能说明
ft.getPerformance获取当前小程序性能相关的信息
ft.reportPerformance小程序测速上报
ft.preloadWebview预加载下个页面的 WebView
ft.preloadSkylineView预加载下个页面所需要的 Skyline 运行环境
ft.preloadAssets为视图层预加载媒体资源文件

#1.5.1 EntryList

请注意

以下 API 暂未支持

名称功能说明
EntryList.getEntries该方法返回当前列表中的所有性能数据
EntryList.getEntriesByType获取当前列表中所有类型为 [entryType] 的性能数据
EntryList.getEntriesByName获取当前列表中所有名称为 [name] 且类型为 [entryType] 的性能数据

#1.5.2 Performance

请注意

以下 API 暂未支持

名称功能说明
Performance.getEntries该方法返回当前缓冲区中的所有性能数据
Performance.getEntriesByType获取当前缓冲区中所有类型为 [entryType] 的性能数据
Performance.getEntriesByName获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据
Performance.createObserver创建全局性能事件监听器
Performance.setBufferSize设置缓冲区大小，默认缓冲 30 条性能数据
PerformanceEntry单条性能数据

#1.5.3 PerformanceObserver

请注意

以下 API 暂未支持

名称功能说明
PerformanceObserver.disconnect停止监听
PerformanceObserver.observe开始监听

#1.6 分包加载

请注意

以下 API 暂未支持

名称功能说明
ft.preDownloadSubpackage触发分包预下载

#1.6.1 PreDownloadSubpackageTask

请注意

以下 API 暂未支持

名称功能说明
PreDownloadSubpackageTask.onProgressUpdate监听分包加载进度变化事件

#1.7 加密

名称功能说明版本
ft.getUserCryptoManager获取用户加密模块3.2.2

#1.7.1 UserCryptoManager

名称功能说明版本
UserCryptoManager.getLatestUserKey获取最新的用户加密密钥3.2.2
UserCryptoManager.getRandomValues获取密码学安全随机数3.2.2


版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。

标签：程序 小程序 管理 间隔 数据
上一篇:小程序框架管理之基础类库
下一篇:小程序API之路由说明
相关文章