开发
API

tt.onAppShow

基础库 1.46.0 开始支持本方法,低版本需做兼容处理。这是一个同步方法。

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

语法

tt.onAppShow(callback);

参数说明

callback

类型默认值必填说明
function小程序切前台事件的回调函数。

callback 回调函数接收 object 参数,属性如下:

属性类型说明
pathstring小程序切前台的路径 (代码包路径)
scenenumber小程序切前台的场景值
queryobject小程序切前台的 query 参数
referrerInfoobject来源信息,从另一个小程序或 App 进入小程序时返回,否则返回 {}。

referrerInfo 的结构

属性类型说明
appIdstring来源小程序的 appId
extraDataobject来源小程序传过来的数据

返回

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

App({
  onLaunch: function () {
    // 请在真机中进行中进行验证,在工具中点击工具栏的刷新按钮也可模拟onShow触发事件,开发者按照自己的业务逻辑进行监听,被触发时机和App.onShow一致。
    tt.onAppShow(function (res) {
      console.log("scene", res.scene);
      console.log("path", res.path);
      console.log("query", res.query);
      console.log("referrerInfo", res.referrerInfo);
    });
  },
});

Bug & Tip

  • Tip:如在打开或跳转小程序时传递了 encode 后的值作为参数,为避免发生页面错误,使用时请自行将拿到的值使用 decodeURIComponent 进行一次 decode 操作。
  • Tip:如果多次注册同一个回调函数,该回调函数会多次执行,代码示例:
App({
  onLaunch: function () {
    function cb() {
      console.log("hello");
    }
    tt.onAppShow(cb);
    tt.onAppShow(cb);
    tt.onAppShow(cb);
    // hello 会被打印三次
  },
});
点击纠错
评价此篇文档