⼩程序api接⼝简单了解汇总⼀.基础:
1.wx.canIUse()
1.wx.canIUse()
判断⼩程序的API,回调,参数,组件等是否在当前版本可⽤
参数:
${API}.${method}.${param}.${option}
${component}.${attribute}.${option} ----->wx.canIUse('input')
${API} 代表 API 名字
${method} 代表调⽤⽅式,有效值为return, success, object, callback
${param} 代表参数或者返回值
${option} 代表参数的可选值或者返回值的属性
${component} 代表组件名字
${attribute} 代表组件属性
${option} 代表组件属性的可选值
返回结果:true或者false
wx.base64ToArrayBuffer()
2.wx.base64ToArrayBuffer()
将 Base64 字符串转成 ArrayBuffer 对象
返回值:ArrayBuffer 对象
实例:
const base64='CxYh'
const arrayBuffer=wx.base64ToArrayBuffer(base64)
wx.arrayBufferToBase64()
3.wx.arrayBufferToBase64()
将 ArrayBuffer 对象转成 Base64 字符串,返回值:Base64 字符串
实例:
const arrayBuffer=new Uint8Array([11,22,33])
const base64=wx.arrayBufferToBase64(arrayBuffer)
⼆.系统信息:
SystemInfo() 获取系统信息
实例:
complete: (res) => { console.log("⼿机型号:"+del) }) wx.getSystemInfo({ complete
complete
complete:接⼝调⽤结束的回调函数(调⽤成功、失败都会执⾏)
success:接⼝调⽤成功的回调函数
success
fail
fail:接⼝调⽤失败的回调函数
SystemInfoSync() ----&SystemInfo 的同步版本
实例:
const SystemInfoSync()
console.log('版本:'+info.version)
三.更新
UpdateManager()
获取全局唯⼀
全局唯⼀的版本更新管理器,⽤于管理⼩程序更新
返回对象:UpdateManager 更新管理器对象
实例:UpdateManager()
2.UpdateManager.applyUpdate()
强制⼩程序重启并使⽤新版本
强制⼩程序重启并使⽤新版本。在⼩程序新版本下载完成后(即收到 onUpdateReady 回调)调⽤。
CheckForUpdate(function callback)
监听向后台请求检查更新结果事件。在⼩程序冷启动时⾃动检查更新,不需由开发者主动触发
监听向后台请求检查更新结果事件
onUpdateFailed(function callback)
UpdateFailed
下载失败(可能是⽹络原因等)后回调监听⼩程序更新失败事件。⼩程序有新版本,客户端主动触发下载(⽆需开发者触发),下载失败
onUpdateReady(function callback)
UpdateReady
下载成功后回调
监听⼩程序有版本更新事件。客户端主动触发下载(⽆需开发者触发),下载成功后回调
实例:
代码测试
四.⼩程序----⽣命周期
LaunchOptionsSync() 获取⼩程序启动时的参数,与 Launch 的回调参数⼀致
返回值:object(⼀个对象)
属性值:
path 启动⼩程序的路径
scene 启动⼩程序的场景
返回对象,启动⼩程序的query参数
query 返回对象
referrerInfo.appId 来源⼩程序、公众好或者App的appId
返回⼀个对象aData 来源⼩程序传过来的数据,scene=1037或1038时⽀持,返回⼀个对象
注意:
百度api接口部分版本在⽆referrerInfo的时候会返回 undefined,建议使⽤ ferrerInfo && ferrerInfo.appId 进⾏判断
EnterOptionsSync()
如果当前是热启动,则返回值
获取本次⼩程序启动时的参数。如果当前是冷启动,则返回值与
的回调参数⼀致;如果当前是热启动,则返回值
如果当前是冷启动,则返回值与 Launch 的回调参数⼀致
与 Show ⼀致
返回值:object(⼀个对象)
属性值和wx.getLaunchOptionsSync()相同
五.⼩程序----监听应⽤级事件
UnhandledRejection(function callback)
ThemeChange(function callback)
监听系统主题改变事件。该事件与 ThemeChange 的回调时机⼀致
PageNotFound(function callback)
监听⼩程序要打开的页⾯不存在事件。该事件与 PageNotFound的回调时机⼀致
Error(function callback)
监听⼩程序错误事件。如脚本错误或 API 调⽤报错等。该事件与 Error 的回调时机与参数⼀致AppShow(function callback)
监听⼩程序切前台事件。该事件与 Show 的回调参数⼀致
AppHide(function callback)
监听⼩程序切后台事件。该事件与 Hide 的回调时机⼀致
六.⼩程序----取消监听应⽤级事件
1.wx.offUnhandledRejection(function callback)
取消监听未处理的 Promise 拒绝事件
2.wx.offThemeChange(function callback)
取消监听系统主题改变事件。
3.wx.offPageNotFound(function callback)
取消监听⼩程序要打开的页⾯不存在事件。
4.wx.offError(function callback)
取消监听⼩程序错误事件
5.wx.offAppShow(function callback)
取消监听⼩程序切前台事件
6.wx.offAppHide(function callback)
取消监听⼩程序切后台事件。
七.⼩程序调试
1.wx.setEnableDebug(Object object)
设置是否打开调试开关。此开关对正式版也能⽣效
实例:
// 打开调试
wx.setEnableDebug({
enableDebug:true
})
// 关闭调试
wx.setEnableDebug({
enableDebug:false
})
实时⽇志管理器对象
2. wx.getRealtimeLogManager() 获取实时
返回:RealtimeLogManager 对象
实例:const RealtimeLogManager()
返回:LogManager 对象
实例:const LogManager({level:1})
level: 取值为0/1,取值为0表⽰是否会把 App、Page的⽣命周期函数和 wx 命名空间下的函数调⽤写⼊⽇志,取值为1则不会。默认值是 0
⼋.页⾯跳转
1.wx.switchTab(Object object) 跳转到 tabBar 页⾯,并关闭其他所有⾮ tabBar 页⾯
Launch(Object object)
关闭所有页⾯,打开到应⽤内的某个页⾯
directTo(Object object)
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论