小程序API基础说明

网友投稿 226 2024-07-07

基础

名称	功能说明	版本
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.getSystemInfoSync	ft.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 小程序的 UserAgent	3.0.45
ft.getDeviceInfo	获取设备基础信息	3.0.45
ft.getAppBaseInfo	获取APP基础信息	3.0.45
ft.getAppAuthorizeSetting	获取APP授权设置	3.0.45

请注意

小程序API基础说明

以下 API 暂未支持

名称	功能说明
ft.getSkylineInfoSync	ft.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 日志	是，但日志只在本地 console	3.0.36
LogManager.info	写 info 日志	是，但日志只在本地 console	3.0.36
LogManager.log	写 log 日志	是，但日志只在本地 console	3.0.36
LogManager.warn	写 warn 日志	是，但日志只在本地 console	3.0.36

#1.4.3 RealtimeLogManager

名称	功能说明	版本	备注
RealtimeLogManager.error	写 error 日志	是，但日志只在本地 console	3.0.36
RealtimeLogManager.info	写 info 日志	是，但日志只在本地 console	3.0.36
RealtimeLogManager.warn	写 warn 日志	是，但日志只在本地 console	3.0.36
RealtimeLogManager.setFilterMsg	设置过滤关键字	是，但日志只在本地 console	3.0.36
RealtimeLogManager.addFilterMsg	添加过滤关键字	是，但日志只在本地 console	3.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

标签：程序小程序管理间隔数据

使用 Class 后出现编译异常的原因及解决方法探讨

226 2024-07-07

微信小程序入门至实战实例分享第四部分详解

226 2024-07-07

微信小程序推广方法之深度探讨与实践经验分享

226 2024-07-07

发表评论

暂时没有评论，来抢沙发吧~

小程序API基础说明

基础

#1.1 系统

#1.2 更新

#1.2.1 UpdateManager

#1.3 小程序

#1.3.1 生命周期

#1.3.2 应用级事件

#1.4 调试

#1.4.1 console

#1.4.2 LogManager

#1.4.3 RealtimeLogManager

#1.4.4 RealtimeTagLogManager

#1.5 性能

#1.5.1 EntryList

#1.5.2 Performance

#1.5.3 PerformanceObserver

#1.6 分包加载

#1.6.1 PreDownloadSubpackageTask

#1.7 加密

#1.7.1 UserCryptoManager

最近发表

更多内容

推荐文章

解决方案

热评文章