# 其它接口
# 触发隐私指引弹窗(选接)
# 接口说明
用于触发微信隐私保护指引弹窗。例如,开发者可以在调用任何真实隐私接口(如获取微信昵称、头像)之前调用此接口来模拟隐私接口调用,并触发微信隐私保护指引弹窗(包括自定义弹窗或平台弹窗)逻辑。
sdkInstance.requirePrivacyAuthorize(options);
最低基础库版本要求
当用户的客户端基础库版本低于 2.32.3 时,调用 sdkInstance.requirePrivacyAuthorize(options) 接口将直接触发失败回调函数,并在正式版环境下于控制台输出错误提示(非正式版环境下,以弹窗形式展示)!
# 参数说明
参数说明如下表所示:
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| success | function | 否 | -- | 接口调用成功的回调函数 |
| fail | function | 否 | -- | 接口调用失败的回调函数 |
| complete | function | 否 | -- | 接口调用完成的回调函数,成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式:JSON 格式。
| 选项 | 类型 | 说明 |
|---|---|---|
| code | number | 响应状态码,为 0 时表示调用成功,其他非 0 状态码均表示调用失败 |
| data | object / null | 调用成功时返回相应信息(因微信API原因,此处可能为空),失败时返回 null |
| message | string | 调用成功或失败时的相应描述信息 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 当用户的客户端基础库版本低于 2.32.3 时,调用此接口将直接触发失败回调函数,并在正式版环境下于控制台输出错误提示(非正式版环境下,以弹窗形式展示)!
sdkInstance.requirePrivacyAuthorize({
showUpgradeMessage: true,
success: function(response) {
console.log(response);
},
fail: function(error) {
console.log(error);
},
complete: function(result) {
// do something here...
}
});
# 退出游戏(选接)
# 接口说明
用于退出当前游戏,需在用户相关点击事件内触发。
sdkInstance.exit(options);
最低基础库版本要求
当用户的客户端基础库版本低于 2.17.3 时,调用 sdkInstance.exit(options) 接口将中断用户当前操作并弹出升级提示,不会报错!
# 参数说明
参数说明如下表所示:
| 选项 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| success | function | 否 | -- | 接口调用成功的回调函数 |
| fail | function | 否 | -- | 接口调用失败的回调函数 |
| complete | function | 否 | -- | 接口调用完成的回调函数,成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式:JSON 格式。
| 选项 | 类型 | 说明 |
|---|---|---|
| code | number | 响应状态码,为 0 时表示调用成功,其他非 0 状态码均表示调用失败 |
| data | object / null | 调用成功时返回相应信息(因微信API原因,此处可能为空),失败时返回 null |
| message | string | 调用成功或失败时的相应描述信息 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 当用户的客户端基础库版本低于 2.17.3 时,调用此接口将中断用户当前操作并弹出升级提示,不会报错!
sdkInstance.exit({
success: function(response) {
console.log(response); // 接口响应,此处response.code为0,表示退出成功
},
fail: function(error) {
console.log(error); // 退出失败的错误信息,error.code为非0状态码,error.message为错误消息
},
complete: function(result) {
// do something here...
}
});