基础

env

ft.env

环境变量

属性

string USER_DATA_PATH

文件系统中的用户目录路径 (本地路径)

base64ToArrayBuffer

ArrayBuffer ft.base64ToArrayBuffer(string base64)

将 Base64 字符串转成 ArrayBuffer 对象

参数

string base64

要转化成 ArrayBuffer 对象的 Base64 字符串

返回值

ArrayBuffer

ArrayBuffer 对象

示例代码

const base64 = 'CxYh'
const arrayBuffer = ft.base64ToArrayBuffer(base64)

arrayBufferToBase64

string ft.arrayBufferToBase64(ArrayBuffer arrayBuffer)

将 ArrayBuffer 对象转成 Base64 字符串

参数

ArrayBuffer arrayBuffer

要转换成 Base64 字符串的 ArrayBuffer 对象

返回值

string

Base64 字符串

示例代码

const arrayBuffer = new Uint8Array([11, 22, 33])
const base64 = ft.arrayBufferToBase64(arrayBuffer)

系统

getSystemInfoSync

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

getSystemInfoSync(Object object)

getSystemInfoSync 同步版本。

getSystemInfoAsync

ft.getSystemInfoAsync(Object object)

异步获取系统信息。需要一定的微信客户端版本支持，在不支持的客户端上，会使用同步实现来返回。

参数

Object object

object.success 回调函数

参数

Object res

safeArea 的结构

theme 的合法值

host 的结构

deviceOrientation 的合法值

示例代码

在开发者工具中预览效果

ft.getSystemInfoAsync({
  success (res) {
    console.log(res.model)
    console.log(res.pixelRatio)
    console.log(res.windowWidth)
    console.log(res.windowHeight)
    console.log(res.language)
    console.log(res.version)
    console.log(res.platform)
  }
})

getSystemInfo

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

getSystemInfo(Object object)

获取系统信息。

参数

Object object

object.success 回调函数 ​ 参数

Object res

示例代码

 ft.getSystemInfo({
  success(res) {
    console.log(res.model)
    console.log(res.pixelRatio)
    console.log(res.windowWidth)
    console.log(res.windowHeight)
    console.log(res.language)
    console.log(res.version)
    console.log(res.platform)
  }
})

更新

getUpdateManager

基础库1.5.30开始支持，iOS版本2.5.6，Android版本2.8.76

获取全局唯一的版本更新管理器，用于管理小程序更新。 返回值UpdateManager

UpdateManager方法

UpdateManager.applyUpdate() 强制小程序重启并使用新版本。在小程序新版本下载完成后（即收到 onUpdateReady 回调）调用。​

UpdateManager.onCheckForUpdate(function callback) 监听向后台请求检查更新结果事件。运行时在小程序冷启动时自动检查更新，不需由开发者主动触发。

UpdateManager.onUpdateReady(function callback) 监听小程序有版本更新事件。客户端主动触发下载（无需开发者触发），下载成功后回调 UpdateManager.onUpdateFailed(function callback) 监听小程序更新失败事件。小程序有新版本，客户端主动触发下载（无需开发者触发），下载失败（可能是网络原因等）后回调。

示例代码

const updateManager = ft.getUpdateManager()

updateManager.onCheckForUpdate(function (res) {
  // 请求完新版本信息的回调
  console.log(res.hasUpdate)
})

updateManager.onUpdateReady(function () {
  ft.showModal({
    title: '更新提示',
    content: '新版本已经准备好，是否重启应用？',
    success: function (res) {
      if (res.confirm) {
        // 新的版本已经下载好，调用 applyUpdate 应用新版本并重启
        updateManager.applyUpdate()
      }
    }
  })
})

updateManager.onUpdateFailed(function () {
  // 新版本下载失败
})

小程序

getLaunchOptionsSync

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

返回值

Object

启动参数

referrerInfo 的结构

forwardMaterials 的结构

chatType 的合法值

返回有效 referrerInfo 的场景

getEnterOptionsSync

Object ft.getEnterOptionsSync()

获取本次小程序启动时的参数。如果当前是冷启动，则返回值与 App.onLaunch 的回调参数一致；如果当前是热启动，则返回值与 App.onShow 一致。

返回值

Object

启动参数

referrerInfo 的结构

forwardMaterials 的结构

chatType 的合法值

返回有效 referrerInfo 的场景

注意

部分版本在无 referrerInfo 的时候会返回 undefined，建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。

onPageNotFound

ft.onPageNotFound(function callback)

监听小程序要打开的页面不存在事件。该事件与 App.onPageNotFound 的回调时机一致。

参数

function callback

小程序要打开的页面不存在事件的回调函数

参数

Object res

注意

• 开发者可以在回调中进行页面重定向，但必须在回调中同步处理，异步处理（例如 setTimeout 异步执行）无效。
• 若开发者没有调用 ft.onPageNotFound 绑定监听，也没有声明 App.onPageNotFound，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。
• 如果回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再第二次回调。

onError

ft.onError(function callback)

监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 App.onError 的回调时机与参数一致。

参数

function callback

小程序错误事件的回调函数

参数

string error

错误信息，包含堆栈

onAppShow

ft.onAppShow(function callback)

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

参数

function callback

小程序切前台事件的回调函数

参数

Object res

referrerInfo 的结构

forwardMaterials 的结构

返回有效 referrerInfo 的场景

注意

部分版本在无referrerInfo的时候会返回 undefined，建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。

onAppHide

ft.onAppHide(function callback)

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

参数

function callback

小程序切后台事件的回调函数

offPageNotFound

ft.offPageNotFound(function callback)

取消监听小程序要打开的页面不存在事件

参数

function callback

小程序要打开的页面不存在事件的回调函数

offError

ft.offError(function callback)

取消监听小程序错误事件。

参数

function callback

小程序错误事件的回调函数

offAppShow

ft.offAppShow(function callback)

取消监听小程序切前台事件

参数

function callback

小程序切前台事件的回调函数

offAppHide

ft.offAppHide(function callback)

取消监听小程序切后台事件

参数

function callback

小程序切后台事件的回调函数

调试

setEnableDebug

ft.setEnableDebug(Object object)

设置是否打开调试开关。此开关对正式版也能生效。

参数

Object object

示例代码

// 打开调试
ft.setEnableDebug({
  enableDebug: true
})

// 关闭调试
ft.setEnableDebug({
  enableDebug: false
})

Tips

• 在正式版打开调试还有一种方法，就是先在开发版或体验版打开调试，再切到正式版就能看到vConsole。