抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 登录
  • 社交转发裂变
  • 用户信息及授权
  • 小游戏收藏
  • 群聊
  • 关注
  • 游戏互推组件
  • 添加到桌面
  • 游戏排行榜
  • 数据分析
  • 视频拍摄器
  • 订阅消息
  • 关系链
  • 客服能力
  • 侧边栏能力
  • tt.checkScene
  • tt.navigateToScene
  • 推荐流直出游戏能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.navigateToScene

    收藏
    我的收藏

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

    调用该API可以跳转到某个小游戏入口场景,目前仅支持跳转「侧边栏」场景。

    前提条件
    业务背景
    使用限制

    仅支持抖音宿主。可以通过 tt.checkScene 判断是否当前宿主是否支持

    注意事项
    • 抖音开发者工具在4.1.5及以上版本支持通过模拟器模拟该API,详见开发者工具更新及下载
    • 通过侧边栏入口进入小游戏时,tt.onShow 会在监听回调中新增两个返回字段 launch_from = 'homepage' 和 location = 'sidebar_card' ,可用于判断用户是否从该入口场景进入小游戏
    相关教程

    语法

    tt.navigateToScene(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    sceneenum

    需要确认的入口场景

    2.92.0
    successfunction
    接口调用成功的回调函数
    2.92.0
    failfunction
    接口调用失败的回调函数
    2.92.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    2.92.0

    scene 的合法值

    说明最低支持版本
    sidebar

    【侧边栏】场景

    2.92.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "navigateToScene:ok"
    2.92.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "navigateToScene:fail" + 详细错误信息
    2.92.0

    错误码

    errNoerrMsg说明最低支持版本
    20001expect params.scene to be one of "sidebar", but got xxx

    参数校验错误:参数类型错误

    2.92.0
    20001expect params.scene to be one of "sidebar", but got "xxx"

    参数校验错误:参数拼写错误

    2.92.0
    20001expect params.scene to be one of "sidebar", but got undefined

    参数校验错误:没有传必传参数

    2.92.0
    21101scene xxx is inaccessible

    xxx入口场景不可达

    2.92.0

    代码示例

    tt.navigateToScene({ scene: "sidebar", success: (res) => { console.log("navigate to scene success"); // 跳转成功回调逻辑 }, fail: (res) => { console.log("navigate to scene fail: ", res); // 跳转失败回调逻辑 }, });