添加到首页

判断是否可添加到支付宝首页

接口说明

用于判断游戏中心是否可被添加到支付宝首页，建议在调用 sdkInstance.addToHomepage(options) 之前先调用此接口进行判断。

sdkInstance.checkHomepage(options);

最低基础库版本要求

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

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 0 时表示接口调用成功，其他非 0 状态码均表示接口调用失败
data	object / null	接口调用成功时返回确认结果，接口调用失败时返回 null
data.available	boolean	游戏中心是否可被添加到支付宝首页
message	string	接口调用成功或失败时的相应描述信息

示例代码

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

// 当用户的客户端基础库版本过低时，调用此接口将直接触发失败回调函数，并在正式版环境下于控制台输出错误提示（非正式版环境下，以弹窗形式展示）
sdkInstance.checkHomepage({
  success: function(response) {
    console.log(response.data.available); // 游戏中心是否可被添加到支付宝首页：true 表示可以添加，false 表示不可添加
  },
  fail: function(error) {
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

添加到支付宝首页

接口说明

用于将游戏中心添加到支付宝首页；建议先调用 sdkInstance.checkHomepage(options) 判断是否可被添加后再调用此接口。

sdkInstance.addToHomepage(options);

最低基础库版本要求

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

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

返回值说明

WARNING

返回值格式：JSON 格式。

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

示例代码

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

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