容器事件通知

小程序容器包含一些的事件回调通知,当事件发生时,应用可以监听到事件通知,方便开发者处理。

事件通知回调函数 功能说明
ok.onHistoryBack 容器事件通知——路由返回时触发通知回调
ok.onNetworkStatusChange 容器事件通知——网络状态变化/设备网络状态切换时触发通知回调
ok.onUpdateComplete 容器事件通知——小程序版本更新完毕时触发通知回调

钩子回调函数

ok.onHistoryBack(callback)

路由返回触发回调。

参数

属性 类型 默认值 必填 说明
callback function - 页面返回事件触发时的回调函数,建议是申明式函数,后期才能移除监听

示例代码

function eventHistoryBack() {
console.log('用户点击返回啦');
}

ok.onHistoryBack(eventHistoryBack);

ok.onNetworkStatusChange(callback)

当小程序网络状态变化、设备网络状态切换时,通知回调。

参数

属性 类型 默认值 必填 说明
callback function - 当(webview/小程序)网络状态变化、设备网络状态切换时的回调函数,建议是申明式函数,后期才能移除监听

callback 接收参数

Object res

属性 类型 默认值 必填 说明
isConnected boolean 是否有网络
networkType string 网络类型

res.networkType 的合法值

属性 类型 说明
wifi string WIFI 网络
2g string 2G 网络
3g string 3G 网络
4g string 4G 网络
unknown string Android 下不常见的网络类型
none string 无网络

示例代码

function eventNetworkStatusChange (res) {
console.log('小程序网络发生变化啦', res.data);
}

ok.onNetworkStatusChange(eventNetworkStatusChange);

ok.onUpdateComplete(callback)

小程序更新完毕通知回调。当客户端处理完资源包的检测、下载、检验等过程后,可通知前端页面更新结果,页面可提示用户有更新或重启,建议是申明式函数,后期才能移除监听。

参数

属性 类型 默认值 必填 说明
callback function - 小程序更新完成事件回调函数

callback 回调函数

Object version

属性 类型 说明
updatableVersion string 可更新的版本
versionType number 版本类型
updateLog string 更新日志

version.versionType的合法值

属性 类型 说明
1 number 开发版
2 number 体验版
3 number 正式版

以上值客户端容器可以从小程序版本更新检测接口获取。

示例代码

function eventUpdateComplete (res) {
console.log('小程序新版本更新完毕啦', res.data);
}

ok.onUpdateComplete(eventUpdateComplete);
  1. 1. 容器事件通知
    1. 1.1. 钩子回调函数
      1. 1.1.1. ok.onHistoryBack(callback)
        1. 1.1.1.1. 参数
        2. 1.1.1.2. 示例代码
      2. 1.1.2. ok.onNetworkStatusChange(callback)
        1. 1.1.2.1. 参数
        2. 1.1.2.2. callback 接收参数
        3. 1.1.2.3. 示例代码
      3. 1.1.3. ok.onUpdateComplete(callback)
        1. 1.1.3.1. 参数
        2. 1.1.3.2. callback 回调函数
        3. 1.1.3.3. 示例代码