- JS API 列表
- 基础
- 网络
- 媒体
- 地图
- 文件
- 开放接口
- 数据缓存
- 地理位置
- 设备
- 画布
- 界面
- 页面导航
- 侧边栏能力
- 行业开放
- AI/AR能力
- 第三方平台
- TTML
- 转发和挂载
- 其它
- 直播能力
tt.getSidebarActivity
更新时间 2024-08-12 11:19:05
收藏
我的收藏基础库 3.6.0 开始支持本方法,低版本需做[兼容处理],这是一个异步方法。
获取生效中侧边栏活动 id 列表,可结合 tt.navigateToScene 一起使用。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 支持宿主:抖音 |
注意事项 | 无 |
支持沙盒 | 否 |
相关教程 | 无 |
语法
tt.getSidebarActivity(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | 3.6.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.6.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.6.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getSidebarActivity:ok" | 3.6.0 |
activityList | array | 生效中活动 id 数组 | 3.6.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getSidebarActivity:fail" + 详细错误信息 | 3.6.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
21501 | server error | 网络错误 | 3.6.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.getSidebarActivity({
success: (data) => {
if (data.activityList.length) {
tt.navigateToScene({
scene: 'sidebar',
activity: data.activityList[0], // 获取到生效中的id,用于调用 tt.navigateToScene
success: (data) => {
console.log(data)
},
fail: (data) => {
console.log(data)
}
})
}
}
})
该文档是否有帮助?
点击纠错