tt.navigateToScene

收藏
我的收藏

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

调用该 API 可以跳转到某个小程序入口场景,目前仅支持跳转「侧边栏」场景。参考下图:​

前提条件
业务背景
使用限制
注意事项
支持宿主:抖音
支持沙盒
相关教程

语法

tt.navigateToScene(options)

参数说明

options 为 object 类型,属性如下:

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

需要确认的入口场景(目前仅支持的入参为'sidebar')​

3.6.0
activitystring

活动 id, 用于控制弹窗活动类型。​

​创建活动id:使用 OpenAPI 创建营销活动 或在小程序控制台-运营-营销-营销活动-复访营销中创建。​

​查询活动id:使用 JsAPI tt.getSidebarActivity、或在小程序控制台-运营-营销-营销活动-复访营销中查询。

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

回调成功

object 类型,属性如下:

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

code 的合法值

说明最低支持版本
0
0 - 成功跳转​
3.6.0
1
1 - 用户取消​
3.6.0

回调失败

object 类型,属性如下:

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

错误码

errNoerrMsg说明最低支持版本
20001expect params.scene to be one of "sidebar", but got xxx ​
参数校验错误:参数类型错误 ​
3.6.0
20001expect params.scene to be one of "sidebar", but got "xxx" ​
参数校验错误:参数拼写错误
3.6.0
20001expect params.scene to be one of "sidebar", but got undefined ​
参数校验错误:没有传必传参数 ​
3.6.0
10104invoke too frequently​
重复调用跳转弹窗​
3.6.0
10401internal error​
内部错误,弹窗拉起失败​
3.6.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.navigateToScene({ scene: 'sidebar', activity: '', // 需改成自己小程序生效中的activity id。activity 为可选项,不填或者填写错误 id,会表现为兜底样式 success: (data) => { console.log(data) }, fail: (data) => { console.log(data) } })