12/12/2024 11:37:56
客户端API
一、各模块渠道支持列表
| 模块 | 功能说明 | 渠道列表 |
|---|---|---|
| 登录模块 | 授权登录 | (1) WeChat (2) QQ (3) Guest (4) Facebook (5) GameCenter (6) Google (7) Twitter (8) Garena (9) Line (10) Apple (11) HMS |
| 好友模块 | 好友 | MSDK 提供获取个人信息和添加 QQ 好友功能 |
| 分享模块 | 发送、分享消息 | (1) WeChat (2) QQ (3) Facebook (4) Twitter (5) System (6) Line (7) WhatsApp (8) Instagram |
| 群组模块 | 创建、获取工会信息 | (1) WeChat (2) QQ |
| 公告模块 | 公告 | MSDK 提供的公告服务 |
| 推送模块 | 消息推送 | (1) TPNS-腾讯云版本 (2) Firebase |
| 事件上报模块 | 集成各数据上报组件 | (1) Adjust (3) AppsFlyer (3) Beacon (4) TDM (5) Facebook (6) Firebase |
| 异常上报模块 | 集成异常上报组件 | (1) Bugly (2) Firebase |
| WebView模块 | 浏览网页，允许原生应用与 WebView 通信 | Android 支持 X5 和系统内核，iOS 提供系统内核 |
| 位置模块 | 提供相关玩家位置的功能 | (1) WeChat (2) QQ |
| 工具模块 | 工具类服务，比如检测应用是否安装 | MSDK 提供的工具类 |
| 扩展模块 | 扩展服务 | MSDK 提供用于封装无法复用现有 MSDK 接口的功能 |
二、集成渠道功能模块
在 GCloud 管理端 下载 SDK 的时候，选择需要的功能渠道模块。 例如微信登录需要下载 WeChat 插件、Facebook 登录需要下载 Facebook 插件等。将插件拷贝到对应的工程中，修改好 MSDK 环境配置中对应的插件配置，然后初始化 SDK 环境，就可以调用 MSDK 提供的各种功能。
三、基础数据结构
3.1 MSDKBaseRet 详解
MSDK 回调的基础结构体，所有的回调结果类都继承自它。该类包含一些基础的信息。
| 成员变量名称 | 类型 | 说明 |
|---|---|---|
| MethodNameId | int | 调用接口的方法标记，对应 MSDKMethodNameID 枚举 |
| RetCode | int | MSDK 的返回码，详情参考 MSDKError 类 |
| RetMsg | string | MSDK 描述信息 |
| ThirdCode | int | 第三方渠道返回码 |
| ThirdMsg | string | 第三方渠道描述信息 |
| ExtraJson | string | 扩展字段 |
四、各方法名枚举说明
4.1 MSDKMethodNameID 详解
C#
C++
public enum MSDKMethodNameID
{
MSDK_METHODNAMEID_UNDEFINE = 000, // 未定义方法名
// Login
MSDK_LOGIN_AUTOLOGIN = 111, // 自动登录
MSDK_LOGIN_LOGIN = 112, // 授权登录
MSDK_LOGIN_BIND = 113, // 绑定
MSDK_LOGIN_GETLOGINRESULT = 114, // 获取登录态
MSDK_LOGIN_SWITCHUSER = 115, // 切换账号
MSDK_LOGIN_QUERYUSERINFO = 116, // 获取个人信息
MSDK_LOGIN_LOGOUT = 117, // 登出
MSDK_LOGIN_LOGINWITHCONFIRMCODE = 118, // 使用确认码登录
MSDK_LOGIN_WAKEUP = 119, // 异账号，比如从游戏中心拉起，从邀请拉起
MSDK_METHOD_SCHEME = 120, // 从第三方APP拉起
MSDK_LOGIN_RESETGUEST = 121, // 重置游客账号
// Friend
MSDK_FRIEND_SHARE = 211, // 分享消息到信息墙，比如微信朋友圈、QQ空间、Facebook
MSDK_FRIEND_SEND_MESSAGE = 212, // 分享消息给好友
MSDK_FRIEND_QUERY_FRIEND = 213, // 获取好友信息，客户端取消该接口
MSDK_FRIEND_ADD_FRIEND = 214, // 添加好友
// Group
MSDK_GROUP_CREATE = 311, // 建群
MSDK_GROUP_BIND = 312, // 绑定群
MSDK_GROUP_GET_GROUP_LIST = 313, // 获取会长的群列表
MSDK_GROUP_GET_GROUP_STATE = 314, // 获取群状态
MSDK_GROUP_JOIN = 315, // 加入现有群
MSDK_GROUP_UNBIND = 316, // 解绑群
MSDK_GROUP_REMIND_TO_BIND = 317, // 提醒会长建群
MSDK_GROUP_SEND_GROUP_MESSAGE = 318, // 发送群消息
MSDK_GROUP_GET_GROUP_RELATION = 319, // 获取群关系
// Webview
MSDK_WEBVIEW_CLOSE = 411, // 关闭网页
MSDK_WEBVIEW_GET_ENCODE_URL = 412, // 获取加密票据
MSDK_WEBVIEW_JS_CALL = 413, // Native调用js代码
MSDK_WEBVIEW_JS_SHARE = 414, // js分享消息到信息墙，比如微信朋友圈、QQ空间、Facebook
MSDK_WEBVIEW_JS_SEND_MESSAGE = 415, // js分享消息好友
// Push
MSDK_PUSH_REGISTER_PUSH = 511, // 注册推送
MSDK_PUSH_UNREGISTER_PUSH = 512, // 注销推送
MSDK_PUSH_SET_TAG = 513, // 注册标签推送
MSDK_PUSH_DELETE_TAG = 514, // 注销标签推送
MSDK_PUSH_ADD_LOCAL_NOTIFICATION = 515, // 添加本地推送
MSDK_PUSH_CLEAR_LOCAL_NOTIFICATION = 516,// 清除本地推送
MSDK_PUSH_NOTIFICAITON_CALLBACK = 517, // 推送回调
MSDK_PUSH_NOTIFICATION_SHOW = 518, // 显示推送消息
MSDK_PUSH_NOTIFICATION_CLICK = 519, // 点击通知消息
MSDK_PUSH_SET_ACCOUNT = 520, // 设置推送账户
MSDK_PUSH_DELETE_ACCOUNT = 521, // 删除推送账户
// Notice
MSDK_NOTICE_LOAD_DATA = 611, // 获取公告数据
// Game
MSDK_GAME_SETUP = 711, // 初始化排行榜功能
MSDK_GAME_SHOW_LEADER_BOARD = 712, // 展示排行榜界面
MSDK_GAME_SET_SCORE = 713, // 设置分数
MSDK_GAME_SHOW_ACHIEVEMENT = 714, // 显示成就排行
MSDK_GAME_UNLOCK_ACHIEVE = 715, // 解锁指定的成就
// Tool
MSDK_TOOLS_FREE_FLOW = 913, // 免流接口
// Crash
MSDK_CRASH_CALLBACK_EXTRA_DATA = 1011, // Crash时额外二进制数据
MSDK_CRASH_CALLBACK_EXTRA_MESSAGE = 1012, // Crash时额外日志
}typedef enum MethodName
{
kMethodNameUndefine = 000, // 未定义方法名
kMethodNameAutoLogin = 111, // 自动登录
kMethodNameLogin = 112, // 授权登录
kMethodNameBind = 113, // 绑定
kMethodNameGetLoginRet = 114, // 获取登录态
kMethodNameSwitchUser = 115, // 切换账号
kMethodNameQueryUserInfo = 116, // 获取个人信息
kMethodNameLogout = 117, // 登出
kMethodNameLoginWithConfirmCode = 118, // 使用确认码登录
kMethodNameWakeUp = 119, // 从游戏中心拉起
KMethodNameScheme = 120, // 从第三方App拉起
kMethodNameResetGuest = 121, // 重置游客账号
kMethodNameShareToWall = 211, // 分享消息到信息墙，比如微信朋友圈、QQ空间、Facebook
kMethodNameSendMessageToFriend = 212, // 分享消息给好友
kMethodNameQueryFriend = 213, // 获取好友信息
kMethodNameAddFriend = 214, // 添加好友
kMethodNameCreateGroup = 311, // 建群
kMethodNameBindGroup = 312, // 绑定群
kMethodNameGetGroupList = 313, // 获取会长的群列表
kMethodNameGetGroupState = 314, // 获取群状态
kMethodNameJoinGroup = 315, // 加入现有群
kMethodNameUnbindGroup = 316, // 解绑群
kMethodNameRemindToBindGroup = 317, // 提醒会长绑群
kMethodNameSendMessageToGroup = 318, // 发送群消息
kMethodNameGetGroupRelation = 319, // 获取群关系
kMethodNameCloseWebViewURL = 411, // 关闭网页
kMethodNameGetEncodeURL = 412, // 获取加密票据
kMethodNameWebViewJsCall = 413, // Native 调用 js 代码
kMethodNameWebViewJsShare = 414, // js 分享消息到信息墙，比如微信朋友圈、QQ空间、Facebook
kMethodNameWebViewJsSendMessage = 415, // js 分享消息给好友
kMethodNameWebViewEmbedProgress = 416, // 打开嵌入式浏览器进度
kMethodNameRegisterPush = 511, // 注册推送
kMethodNameUnregisterPush = 512, // 注销推送
kMethodNameSetTagForPush = 513, // 注册标签推送
kMethodNameDeleteTagForPush = 514, // 注销标签推送
kMethodNameAddLocalNotify = 515, // 添加本地推送
kMethodNameClearLocalNotify = 516, // 清除本地推送
kMethodNameNotifyCallback = 517, //
kMethodNameNotifyShow = 518, //
kMethodNameNotifyClick = 519, //
kMethodNameSetAccountPush = 520, //
kMethodNameDeleteAccountPush = 521, //
kMethodNameLoadNoticeData = 611, // 获取公告数据
kMethodNameSetupGame = 711, // 初始化排行榜功能
kMethodNameShowGameLeaderBoard = 712, // 展示排行榜界面
kMethodNameSetScore = 713, // 设置分数
kMethodNameShowGameAchievement = 714, // 显示成就排行
kMethodNameUnlockGameAchieve = 715, // 解锁指定的成就
KMethodNameToolsOpenDeepLink = 911, // 打开 DeepLink
KMethodNameToolsConvertShortUrl = 912, // 转化短链
KMethodNameToolsGetFreeFlowInfo = 913, // 获取免流信息
kMethodNameCrashExtraData = 1011, // 额外二进制数据
kMethodNameCrashExtraMessage = 1012, // 额外日志
}MethodName;Copyright © 2024 MSDK.
All rights reserved.
All rights reserved.