用户系统接口

来自AnySDK 文档
跳转至: 导航搜索

获取用户系统对象

  • 接口名称:anysdk.agentManager.getUserPlugin
  • 接口说明:获取用户系统对象
  • 参数列表:无
  • 返回值:用户系统对象
  • 范例:
var userPlugin = anysdk.agentManager.getUserPlugin();

设置监听及消息回调

  • 接口名称:userPlugin.setListener
  • 接口说明:设置监听及消息回调
  • 参数列表:
参数名称 参数说明
callback 必填,用户系统相关消息的回调函数
  • 返回值:无
  • 回调函数返回值:
参数名称 参数说明
code 0 为成功,其他为失败
msg 相关信息
target 可选,目标监听对象
  • 异步回调信息:
回调信息 code msg
初始化成功 anysdk.UserActionResultCode.kInitSuccess 错误信息描述
初始化失败 anysdk.UserActionResultCode.kInitFail 错误信息描述
  • 范例:
userPlugin.setListener(function onUserResult(code, msg){

}, this);

登录

  • 接口名称:userPlugin.login
  • 接口说明:游戏进行登录,登录流程如下图

登陆流程.jpg

1、游戏客户端调用登录接口(向渠道平台服务器发起登录请求)
2、用户登录成功,渠道平台服务器返回认证码
3、AnySDK 框架拿着认证码向游戏服务器请求登录验证
4、游戏服务器将认证码转发给 AnySDK 服务器
5、AnySDK 服务器向渠道平台服务器进行用户登录验证
6、AnySDK 服务器接收验证结果
7、AnySDK 服务器将结果转发给游戏服务器
8、游戏服务器通知 AnySDK 框架登录验证结果
  • 参数列表:
参数名称 参数说明
serverID 可选,登录服务器 ID 默认为 1

返回值:无 异步回调信息:

回调信息 code msg
登录成功 anysdk.UserActionResultCode.kLoginSuccess 游戏服务端返回的信息
登录失败 anysdk.UserActionResultCode.kLoginFail 错误信息描述
登录取消 anysdk.UserActionResultCode.kLoginCancel 错误信息描述
登录网络错误 anysdk.UserActionResultCode.kLoginNetWorkError 错误信息描述
  • 范例:
userPlugin.login();

获取用户唯一标识符

  • 接口名称:userPlugin.getUserID
  • 接口说明:同步接口,获取用户唯一标识符
  • 参数列表:无
  • 返回值:用户唯一标识符
  • 范例:
var userID = userPlugin.getUserID();

获取用户信息

  • 接口名称:userPlugin.getUserInfo
  • 接口说明:异步接口,获取用户信息
  • 参数列表:无
  • 返回值:无
  • 异步回调信息:
回调信息 code msg
获取用户信息成功 anysdk.UserActionResultCode.kGetUserInfoSuccess 用户信息 json 字符串
获取用户信息失败 anysdk.UserActionResultCode.kGetUserInfoFail 错误信息描述
  • 范例:
userPlugin.getUserInfo();

获取登录状态

  • 接口名称:userPlugin.isLogined
  • 接口说明:获取登录状态
  • 参数列表:无
  • 返回值:true 已登录,false 未登录
  • 范例:
var status = userPlugin.isLogined();

登出

  • 接口名称:userPlugin.logout
  • 接口说明:游戏登出
  • 参数列表:无
  • 返回值:无
  • 异步回调信息:
回调信息 code msg
登出成功 anysdk.UserActionResultCode.kLogoutSuccess 错误信息描述
登出失败 anysdk.UserActionResultCode.kLogoutFail 错误信息描述
  • 范例:
userPlugin.logout();

发送到桌面快捷方式

  • 接口名称:userPlugin.sendToDesktop
  • 接口说明:在桌面创建游戏快捷图标
  • 参数列表:无,但为方便扩展请传对象为{}
  • 返回值:无
  • 异步回调信息:
回调信息 code msg
发送成功 anysdk.UserActionResultCode.kSendToDesktopSuccess 错误信息描述
发送失败 anysdk.UserActionResultCode.kSendToDesktopFail 错误信息描述
  • 范例
var params = {url: "play.cocos.com"}
userPlugin.sendToDesktop(params);

进入论坛(话题圈)

  • 接口名称:userPlugin.openBBS
  • 接口说明:进入论坛(话题圈)
  • 参数列表:
参数名称 参数说明
url 必填,论坛地址。有些渠道可以为"",由渠道自己控制跳转地址。(如腾讯系渠道)
  • 异步回调信息:
回调信息 code msg
进入论坛成功 anysdk.UserActionResultCode.kOpenBBSSuccess 错误信息描述
进入论坛失败 anysdk.UserActionResultCode.kOpenBBSFail 错误信息描述
  • 范例
var params = {url: ""}
userPlugin.openBBS(params);

获取可登录类型

  • 接口名称:userPlugin.getAvailableLoginType
  • 接口说明:设置游戏登录类型
  • 参数列表:无,但为方便扩展请传对象为{}
  • 返回值:无
  • 异步回调信息:
回调信息 code msg
获取成功 anysdk.UserActionResultCode.kGetAvailableLoginTypeSuccess 登录类型 json 字符串
获取失败 anysdk.UserActionResultCode.kGetAvailableLoginTypeFail 错误信息描述
  • 范例
var param = {};
userPlugin.getAvailableLoginType(params);
  • 成功返回值范例
{"msg":"getAvailableLoginType succeed","result":0,"loginTypes":[{"loginType":"qq"},{"loginType":"wx"}]}

设置登录类型

  • 接口名称:userPlugin.setLoginType
  • 接口说明:设置游戏登录类型
  • 参数列表:
参数名称 参数说明
loginType 必填,登录类型为"qq"、"wx"、"guest"
  • 返回值:无
  • 范例
userPlugin.setLoginType("qq");