tt.navigateToScene
基础库 3.6.0 开始支持本方法,低版本需做[兼容处理],这是一个异步方法。
调用该 API 可以跳转到某个小程序入口场景,目前仅支持跳转「侧边栏」场景。参考下图:
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 支持宿主:抖音 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.navigateToScene(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| scene | enum | 是 | 需要确认的入口场景(目前仅支持的入参为'sidebar') | 3.6.0 | |
| activity | string | 是 | 活动 id, 用于控制弹窗活动类型。 创建活动id:使用 OpenAPI 创建营销活动 或在小程序控制台-运营-营销-营销活动-复访营销中创建。 查询活动id:使用 JsAPI tt.getSidebarActivity、或在小程序控制台-运营-营销-营销活动-复访营销中查询。 | 3.6.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 3.6.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 3.6.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.6.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| code | enum | code | 3.6.0 |
| errMsg | string | "navigateToScene:ok" | 3.6.0 |
code 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| 0 | 0 - 成功跳转 | 3.6.0 |
| 1 | 1 - 用户取消 | 3.6.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "navigateToScene:fail" + 详细错误信息 | 3.6.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 173086 | invoke too frequently | D | 调用频繁 | 3.6.0 |
| 173091 | internal error | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.6.0 |
| 173099 | expect params.scene to be one of "sidebar" or params.activity should be string | D | 参数错误 请根据错误信息修改参数类型 | 3.6.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.navigateToScene({ scene: 'sidebar', activity: '', // 需改成自己小程序生效中的activity id。activity 为可选项,不填或者填写错误 id,会表现为兜底样式 success: (data) => { console.log(data) }, fail: (data) => { console.log(data) } })
