tt.navigateToScene

更新时间 2024-07-24 02:58:49
收藏
我的收藏
基础库 3.6.0 开始支持本方法,低版本需做[兼容处理],这是一个异步方法。​
支持宿主:抖音​
调用该 API 可以跳转到某个小程序入口场景,目前仅支持跳转「侧边栏」场景。参考下图:​

语法​

JavaScript
复制
tt.navigateToScene(options)

参数说明​

options 为 object 类型,属性如下:​
属性名​
类型​
默认值​
必填​
说明​
最低支持版本​
activity​
string​
否​
活动 id, 用于控制弹窗活动类型。​
创建活动id:使用 OpenAPI 创建营销活动 或在小程序控制台-运营-营销-营销活动-复访营销中创建。​
查询活动id:使用 JsAPI tt.getSidebarActivity、或在小程序控制台-运营-营销-营销活动-复访营销中查询。​
3.6.0​
scene​
string​
是​
需要确认的入口场景(目前仅支持的入参为'sidebar')​
3.6.0​
success​
Function​
否​
接口调用成功的回调函数​
3.6.0​
complete​
Function​
否​
接口调用结束的回调函数(调用成功、失败都会执行)​
3.6.0​
fail​
Function​
否​
接口调用失败的回调函数​
3.6.0​

回调成功 ​

object 类型,属性如下:​
属性名
类型
说明
最低支持版本
errMsg​
string​
错误信息​
3.6.0​
errNo​
number​
错误码​
3.6.0​
code​
string​
0 - 成功跳转​
1 - 用户取消​
3.6.0​

回调失败 ​

object 类型,属性如下:​
属性名
类型
说明
最低支持版本
errMsg​
string​
错误信息​
3.6.0​
errNo​
number​
错误码​
3.6.0​

错误码&错误信息​

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

扫码体验​

代码示例​

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

Bug & Tip​

无​