抖音开放平台Logo
控制台

tt.onShow

更新时间 2024-07-24 02:58:49
收藏
我的收藏

基础库 1.0.0 开始支持本方法,这是一个同步方法。

监听小游戏回到前台的事件。

前提条件
业务背景
使用限制
注意事项
相关教程

语法

tt.onShow(callback)

参数说明

callback

类型默认值必填说明最低支持版本
function
小游戏回到前台的事件回调
1.0.0

callback 是一个回调函数,接收 object 类型的参数,属性如下:

属性名类型说明最低支持版本
queryobject
启动参数
1.0.0
scenestring

启动场景值。(查看方式:1. 抖音开放平台-场景值;2.)抖音开发者工具中,普通编译 -> 添加编译模式 -> 进入场景)

1.0.0
refererInfoobject
来源信息,从另一个小程序进入小程序时返回,否则返回空对象 {}
1.0.0
launch_fromstring
启动场景字段
1.0.0
locationstring
启动场景字段
1.0.0

launch_from 参数说明

launch_from 和 location 只有在某些启动场景才会返回。目前支持返回这两个参数的启动场景如下:

启动场景

launch_from返回值

location返回值

抖音首页侧边栏

homepage

sidebar_card

侧边栏高价值区

homepage

homepage_expand

refererInfo 类型说明

object 类型,属性如下:

属性名类型说明最低支持版本
appIdstring
来源小程序 appId
1.0.0
extraDataobject
来源小程序传过来的数据
1.0.0

返回值

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.onShow((res) => {
  console.log("启动参数:", res.query);
  console.log("来源信息:", res.refererInfo);
  console.log("场景值:", res.scene);
  console.log("启动场景字段:", res.launch_from, ", ", res.location);
});