侧边栏复访能力

随着快手小游戏复访能力的完善，快手首页侧边栏日活持续增高，平台推荐开发者均接入快手首页侧边栏复访教育，引导用户从首页侧边栏进入游戏，养成打开快手 > 打开首页侧边栏 > 快速访问游戏的心智，大幅提升次留、7留。​

有关侧边栏复访能力的更多内容，如应用实例、方案示意，请自行阅读《侧边栏复访能力技术指南》 (opens new window)，本文档不做赘述：

判断是否支持跳转至侧边栏

接口说明

用于判断当前宿主环境是否支持跳转至某个游戏入口场景，目前仅支持「侧边栏」场景。

sdkInstance.checkScene(options);

最低基础库版本要求

当用户客户端基础库版本过低时，调用 sdkInstance.checkScene(options) 接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
scene	string	否	sidebar	待确认的入口场景，目前仅支持 sidebar 侧边栏
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 0 时表示接口调用成功，其他非 0 状态码均表示接口调用失败
data	object / null	接口调用成功时返回确认结果，接口调用失败时返回 null
data.isExist	boolean	为 true 时表示支持跳转，为 false 时表示不支持跳转
message	string	接口调用成功或失败时的相应描述信息

示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 当用户客户端基础库版本过低时，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）！
sdkInstance.checkScene({
  scene: "sidebar",
  success: function(response) {
    // 支持跳转
    if (response.data.isExist) {
      // do something here...
    }
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

跳转至侧边栏

接口说明

用于跳转至某个游戏入口场景，目前仅支持「侧边栏」场景。

sdkInstance.navigateToScene(options);

最低基础库版本要求

当用户客户端基础库版本过低时，调用 sdkInstance.navigateToScene(options) 接口将中断用户当前操作并弹出升级提示，不会报错！

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
scene	string	否	sidebar	待跳转的入口场景，目前仅支持 sidebar 侧边栏
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 0 时表示接口调用成功，其他非 0 状态码均表示接口调用失败
data	object / null	接口调用失败时返回 null
message	string	接口调用成功或失败时的相应描述信息

示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 当用户客户端基础库版本过低时，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
sdkInstance.navigateToScene({
  scene: "sidebar",
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});