小程序常用PAI汇总

API

wx.canlUse(string schema)

判断小程序的API，回调，参数，组件等是否在当前版本可用。
返回值boolean

ArrayBuffer wx.base64ToArrayBuffer(string base64)

将 Base64 字符串转成 ArrayBuffer 对象

string wx.arrayBufferToBase64(ArrayBuffer arrayBuffer)

将 ArrayBuffer 对象转成 Base64 字符串

Object wx.getSystemInfoSync()

获取系统信息：包含设备型号相关以及微信版本等。

wx.getSystemInfo(Object object)

参数是success，fail，complete

Object wx.getLaunchOptionsSync()

获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。

wx.onPageNotFound(function callback)

监听小程序要打开的页面不存在事件。该事件与 App.onPageNotFound 的回调时机一致
回调函数的参数有path（不存在页面的路径），query（打开不存在页面的query参数），isEntryPage(是否本次启动的首个。

wx.onAppShow(function callback)

监听小程序切前台事件。该事件与 App.onShow 的回调参数一致

wx.onAppHide(function callback)

监听小程序切后台事件。该事件与 App.onHide 的回调时机一致。

wx.showToast(Object object)

显示消息提示框

wx.showToast({
  title: '成功',
  icon: 'success',
  duration: 2000
})

注意

• wx.showLoading 和 wx.showToast 同时只能显示一个
• wx.showToast 应与 wx.hideToast 配对使用

wx.showModal(Object object)

显示模态对话框

wx.showLoading(Object object)

显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框

wx.setNavigationBarTitle(Object object)

动态设置当前页面的标题

wx.setNavigationBarTitle({
  title: '当前页面'
})

wx.login(Object object)

调用接口获取登录凭证（code），通过凭证进而换取用户登录信息，包括用户的唯一标识（openid）以及本次登录的会话密钥（session_key），用户数据的加解密通讯需要依赖会话密钥完成。
参数：
timeout：超时时间
success：接口调用成功的回调函数——回调函数的参数code（登录凭证有效时间5分钟）
fail：接口调用失败的回调函数
complete：接口调用结束的回调函数（无论成功还是失败都会执行）

wx.getSetting(Object object)

获取用户的当前设置。返回值中只会出现小程序已经向用户请求过的权限
获取用户授权设置：开发者可以使用wx.getSetting获取yoghurt当前的授权状态。
该接口的成功回调中有有个authSetting参数对象，该对象包含了用户所开放的授权状态

wx.openSetting(Object object)

调起客户端小程序设置界面，返回用户设置的操作结果。设置界面只会出现小程序已经向用户请求过的权限。
注意：2.3.0 版本开始，用户发生点击行为后，才可以跳转打开设置页，管理授权信息。详情。

wx.getLocation(Object object)——调用前需要用户授权

获取当前的地理位置、速度。当用户离开小程序后，此接口无法调用。
参数：type：wgs84 返回 gps 坐标，gcj02 返回可用于 wx.openLocation 的坐标

wx.checkSession（Object object）

检查登录态是否过期。

wx.checkSession({
  success () {
    //session_key 未过期，并且在本生命周期一直有效
  },
  fail () {
    // session_key 已经失效，需要重新执行登录流程
    wx.login() //重新登录
  }
})