# 其它接口

# 触发隐私指引弹窗(选接)

# 接口说明

用于触发微信隐私保护指引弹窗。例如,开发者可以在调用任何真实隐私接口(如获取微信昵称、头像)之前调用此接口来模拟隐私接口调用,并触发微信隐私保护指引弹窗(包括自定义弹窗或平台弹窗)逻辑。

sdkInstance.requirePrivacyAuthorize(options);

最低基础库版本要求

若用户客户端基础库版本低于 2.32.3,调用 sdkInstance.requirePrivacyAuthorize(options) 接口将弹出升级提示,并返回 undefined,若需禁用升级提示,可将 options.showUpgradeMessage 参数显式的设为 false

# 参数说明

参数说明如下表所示:

选项 类型 必填 默认值 说明
showUpgradeMessage boolean true 在用户客户端基础库版本低于 2.32.3 时是否弹出升级提示
success function -- 用户同意授权时的回调函数
fail function -- 用户拒绝授权时的回调函数,返回错误信息
complete function -- 用户完成授权时的回调函数,成功或失败均会调用

# 示例代码

注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!

sdkInstance.requirePrivacyAuthorize({
  showUpgradeMessage: true,
  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...
  }
});

# 退出游戏(选接)

# 接口说明

用于退出当前游戏,需在用户相关点击事件内触发。

sdkInstance.exit(options);

最低基础库版本要求

若用户客户端基础库版本低于 2.17.3,调用 sdkInstance.exit(options) 接口将中断用户当前操作并弹出升级提示,不会报错!

# 参数说明

参数说明如下表所示:

选项 类型 必填 默认值 说明
success function -- 退出成功的回调函数
fail function -- 退出失败的回调函数,返回错误信息
complete function -- 退出完成的回调函数,成功或失败均会调用

# 示例代码

注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!

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...
  }
});
Last Updated: 2025/1/22 14:37:52