# 侧边栏复访能力
随着快手小游戏复访能力的完善,快手首页侧边栏日活持续增高,平台推荐开发者均接入快手首页侧边栏复访教育,引导用户从首页侧边栏进入游戏,养成打开快手 > 打开首页侧边栏 > 快速访问游戏的心智,大幅提升次留、7留。
有关侧边栏复访能力的更多内容,如应用实例、方案示意,请自行阅读《侧边栏复访能力技术指南》 (opens new window),本文档不做赘述:
# 判断侧边栏是否可用
# 接口说明
用于判断当前宿主环境侧边栏是否可用。
sdkInstance.checkSliderBarIsAvailable(options);
# 参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
success | function | 否 | -- | 接口调用成功的回调函数 |
fail | function | 否 | -- | 接口调用失败的回调函数 |
complete | function | 否 | -- | 接口调用完成的回调函数,成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式:JSON
格式。
选项 | 类型 | 说明 |
---|---|---|
code | number | 响应状态码,为 0 时表示接口调用成功,其他非 0 状态码均表示接口调用失败 |
data | object / null | 接口调用成功时返回确认结果,接口调用失败时返回 null |
data.available | boolean | 为 true 时表示侧边栏可用,为 false 时表示侧边栏不可用 |
message | string | 接口调用成功或失败时的相应描述信息 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 当用户客户端基础库版本过低时,调用此接口将中断用户当前操作并弹出升级提示,不会报错!
sdkInstance.checkSliderBarIsAvailable({
success: function(response) {
// 侧边栏可用
if (response.data.available) {
// do something here...
}
},
fail: function(error) {
sdkInstance.modal.message(error.message);
},
complete: function(result) {
// do something here...
}
});