# 登录退出
# 1、登录
用于执行登录并获取SDK开放平台用户信息。
sdk.login(callback);
注意事项
一般情况下,流程上要求需先执行SDK登录,再显示游戏服列表及"开始游戏"按钮,当玩家点击"开始游戏"后再触发后续游戏服登录及创角;若游戏本身并无游戏服列表选择界面或"开始游戏"按钮,此注意事项可忽略!
示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdk.login((response) => {
// 登录成功
if (response.code == 0) {
console.log(response.data); // 用户信息,同实例 sdk.userInfo
}
// 登录失败
else {
console.log("登录失败");
}
});
# 2、退出
用于执行游戏内退出登录。
sdk.logout(callback);
注意事项
在退出成功的回调函数中,游戏应清除当前登录的账号角色等信息,重回游戏起始页,并再次调用 sdk.login 接口以拉起登录窗口。一般情况下,当游戏内有"退出登录"按钮,并在玩家点击该按钮时才调用此接口,若游戏本身无此设计,此接口可忽略!
示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdk.logout((response) => {
// 在退出成功的回调函数中,理论上游戏应按如下步骤执行相关操作:
// 第一步,清除当前登录的账号角色等信息
// 第二步,重回游戏起始页
// 第三步,再次调用 sdk.login 接口以拉起登录窗口
});
# 3、悬浮窗内退出 第三方渠道时必接
监听游戏壳悬浮窗内退出登录事件,并非点击游戏内"退出登录"按钮进行账号退出,退出成功时执行该回调,游戏壳悬浮窗入口脱离游戏本身,一般悬浮在游戏画面左/右侧。
sdk.setLogoutNotification(callback);
注意事项
- 若游戏上架为
欢游或Quick渠道,则此方法必接,若上架为官方H5或官方微端包可不接入; - 该方法应在SDK初始化后立即调用;
- 部分渠道游戏壳子带有悬浮窗,玩家于悬浮窗内退出登录时,相应事件的回调函数会被触发,回调内需调用
sdk.login方法以拉起登录弹窗,和sdk.logout方法的回调函数处理逻辑可保持完全一致。
示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdk.setLogoutNotification((response) => {
// 在退出成功的回调函数中,理论上游戏应按如下步骤执行相关操作:
// 第一步,清除当前登录的账号角色等信息
// 第二步,重回游戏起始页
// 第三步,再次调用 sdk.login 接口以拉起登录窗口
});
# 4、悬浮窗内切换账号 第三方渠道时必接
监听游戏壳悬浮窗内切换账号事件,并非点击游戏内"切换账号"按钮进行账号切换,切换成功时执行该回调,游戏壳悬浮窗入口脱离游戏本身,一般悬浮在游戏画面左/右侧。
sdk.setSwitchAccountNotification(callback);
注意事项
- 若游戏上架为
欢游或Quick渠道,则此方法必接,若上架为官方H5或官方微端包可不接入; - 该方法应在SDK初始化后立即调用;
- 部分渠道游戏壳子带有悬浮窗,玩家于悬浮窗内切换账号时,相应事件的回调函数会被触发,回调内会返回
新账号信息,禁止再次调用sdk.login方法。
示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdk.setSwitchAccountNotification((response) => {
// 在切换账号成功的回调函数中,理论上游戏应按如下步骤执行相关操作:
// 第一步,清除当前登录的账号角色等信息
// 第二步,重回游戏起始页
// 第三步,使用回调函数中返回的新账号信息重新进入游戏(该回调函数中禁止再次调用 sdk.login 接口)
console.log(response.data); // 返回的新账号信息,同 sdk.login 接口调用成功时返回的数据结构一致
});
# 5、监听防沉迷事件 官方渠道时必接
监听防沉迷机制触发事件;若未成年人游戏时间超过国家规定的健康时间,将会被强制下线促使玩家休息。
sdk.setPreventAddictionNotification(callback);
注意事项
- 若游戏上架为
官方H5或官方微端包,则此方法必接,若上架为欢游或Quick渠道,可不接入; - 该方法应在SDK初始化后立即调用;
- 玩家触发防沉迷机制,被强制下线时,相应事件的回调函数会被触发,回调内需调用
sdk.login方法以拉起登录弹窗。
示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdk.setPreventAddictionNotification((reponse) => {
// 在被强制下线后的回调函数中,理论上游戏应按如下步骤执行相关操作:
// 第一步,清除当前登录的账号角色等信息
// 第二步,重回游戏起始页
// 第三步,再次调用 sdk.login 接口以拉起登录窗口
});
# 6、关闭游戏
关闭游戏,杀掉游戏进程。一般情况下,当玩家首次进入游戏时,应向其弹出隐私协议等相关弹窗,在玩家点击"同意"时,正常进入游戏,反之点击"拒绝"时,应调用该接口直接关闭游戏。
sdk.exit();
注意事项
该方法仅适用于 官方微端包、欢游 和 Quick 渠道包环境,其它环境不支持。
示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
sdk.exit();