WARNING

💡 模块名:GameHelper.Login

描述

目前登录都需要依赖渠道的登录接口，用于直接或者间接的获得用户的 openId。

微信渠道可以静默获得登录的返回,其他渠道存在两种情况。

若用户已经登陆了，则自动登录并静默返回。若未登录，会强制拉起渠道登录页面，直到用户登录成功后，才会有返回。

接口索引

属性

属性	类型	描述
isSupportServer	boolean	是否支持服务器登录
loginStatus	string	渠道登陆状态
openId	string	用户 ID
touristId	string	游客 ID
workId	string	业务 ID,openID 存在的情况下是 openID,否则拿到的是 touristID
loginInfo	any	登录成功后的信息

方法

普通登录，直接调用渠道的登录接口，可以获取渠道默返回的一些数据信息。

reacquire 为 true 时，无论之前是否已经登录，都会再调用一次登录接口。否则，若已经登录，则直接返回上一次成功登录的结果。

参数	类型	默认值	是否必填	说明
opt	LoginParams	object	是	登录参数

LoginParams

参数	类型	默认值	是否必填	说明
success	(res) => void	/	是	成功回调
failurl	(res) => void	/	是	失败回调
reacquire	boolean	false	否	是否强制重新登录
needToken	boolean	false	否	是否需要 token 来再次获取服务器信息

返回值

无

示例

GameHelper.Login.login({
  reacquire: false, //是否强制重新登录
  needToken: false, //是否需要token
  success(res) {
    console.log("登录成功!", res);
  },
  fail(err) {
    console.log("登录失败!", err);
  },
});

---

获取 openId 的接口，若之前有本地缓存，则直接返回。否则调用 login 进行登录并获取 openId。当 login 返回失败时，若启用了游客模式则返回一个 uuid 作为 openId 使用，反之返回空字符串。

参数	类型	默认值	是否必填	说明
opt	OpenIdParams	object	是	参数

OpenIdParams

参数	类型	默认值	是否必填	说明
useTourist	boolean	false	否	是否使用游客模式
callback	(res:{openId:string}) => void	/	是	回调函数

返回值

无

示例

GameHelper.Login.getOpenId({
  useTourist: true,
  callback(res) {
    console.log("openId：", res.openId);
  },
});