tt.checkScene
收藏
我的收藏基础库 2.92.0 开始支持本方法,这是一个异步方法。
确认当前宿主版本是否支持跳转某个小游戏入口场景,目前仅支持「侧边栏」场景。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
相关教程 | 无 |
语法
tt.checkScene(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
scene | enum | 是 | 需要确认的入口场景 | 2.92.0 | |
success | function | 否 | 接口调用成功的回调函数 | 2.92.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 2.92.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.92.0 |
scene 的合法值
值 | 说明 | 最低支持版本 |
---|---|---|
sidebar | 【侧边栏】场景 | 2.92.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
isExist | boolean | 入口场景是否存在 | 2.92.0 |
errMsg | string | "checkScene:ok" | 2.92.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "checkScene:fail" + 详细错误信息 | 2.92.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
20001 | expect params.scene to be one of "sidebar", but got xxx | 参数校验错误:参数类型错误 | 2.92.0 |
20001 | expect params.scene to be one of "sidebar", but got "xxx" | 参数校验错误:参数拼写错误 | 2.92.0 |
20001 | expect params.scene to be one of "sidebar", but got undefined | 参数校验错误:没有传必传参数 | 2.92.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.checkScene({ scene: "sidebar", success: (res) => { console.log("check scene success: ", res.isExist); //成功回调逻辑 }, fail: (res) => { console.log("check scene fail:", res); //失败回调逻辑 } });
点击纠错