跳到主要内容
版本：v7

开发指南

监听用户状态变化​

在执行登录接口前，需要先设置全局的用户状态变化回调，以方便游戏响应退出登录、第三方账号绑定/解绑成功等状态变更。

// MainActivity.java

import com.xd.sdk.account.XDGAccount;
import com.xd.sdk.common.callback.XDGUserStatusChangeCallback;

import org.jetbrains.annotations.Nullable;

// ...

private void addUserStatusChangeCallback() {
    XDGAccount.addUserStatusChangeCallback(new XDGUserStatusChangeCallback() {
        @Override
        public void userStatusChange(int code, @Nullable String message) {
            if (code == XDGUserStatusChangeCallback.UserStatus.LOGOUT) {
                // 退出登录，回到登录页面，展示登录按钮
            } else if (code == XDGUserStatusChangeCallback.UserStatus.BIND) {
                // 绑定成功，没有更多登录方式可不处理
            } else if (code == XDGUserStatusChangeCallback.UserStatus.UNBIND) {
                // 解绑成功，没有更多登录方式可不处理
            } else if (code == XDGUserStatusChangeCallback.UserStatus.PROTOCOL_AGREED_AFTER_LOGOUT) {
                // 退出登录后同意协议，可不处理
            } else if (code == XDGUserStatusChangeCallback.UserStatus.CUSTOMER_NO_UNREAD_MESSAGE) {
                // 客服有未读消息，未开通服务可以不处理
            } else if (code == XDGUserStatusChangeCallback.UserStatus.CUSTOMER_HAS_UNREAD_MESSAGE) {
                // 客服没有未读消息，未开通服务可以不处理
            } else {
                // 未知 Code，不需要处理
            }
        }
    });
}

发起登录​

需要在初始化成功后才可使用登录相关功能。

普通登录​

  1. 调用 LoginByType(Default) 进行自动登录，如果玩家之前已经登录过且还未过期，则能直接登录成功。
  2. 如果自动登录返回失败，则游戏需要绘制包含各类型登录按钮的登录页面，等待玩家选择登录方式。
  3. 玩家点击登录按钮时调用 LoginByType(targetType) ，需要传入对应的登录类型来触发对应的流程并等待接口回调。
  4. 登录成功后，游戏可获取到用户的 XD User ID 以及头像、昵称等信息，之后可引导玩家进入游戏主流程。
  5. 当用户状态回调退出登录时，游戏需要同步退出登录状态并引导玩家重新登录。

注意事项：

  • 手动登录时，游戏可以在点击后短时间内屏蔽重复点击，但请勿长时间禁用登录按钮，SDK 无法保证所有情况下的登录一定会有回调。
  • 自动登录在整个游戏生命周期内只需要调用一次，如果玩家退出登录后回到登录页面时，不需要再次调用自动登录接口。
  • 登录成功后不再需要调用 TrackUser 方法，SDK 会自动处理用户行为上报。
  • 国内游戏在登录成功后不再需要处理实名和防沉迷相关逻辑，SDK 会自动处理相关逻辑。
// LoginActivity.java

import android.util.Log;

import com.xd.sdk.account.XDGAccount;
import com.xd.sdk.common.base.XDGError;
import com.xd.sdk.common.bean.XDGUser;
import com.xd.sdk.common.callback.Callback;
import com.xd.sdk.common.entities.LoginEntryType;

import java.util.Map;

// ...

/**
 * 登录
 *
 * LoginEntryType 枚举：
 *   LoginEntryType.DEFAULT - 自动登录
 *   LoginEntryType.TAP_TAP - TapTap 登录
 *   LoginEntryType.APPLE - Apple 登录
 *   LoginEntryType.GOOGLE - Google 登录
 *   LoginEntryType.FACEBOOK - Facebook 登录
 *   LoginEntryType.LINE - LINE 登录
 *   LoginEntryType.TWITTER - Twitter 登录
 *   LoginEntryType.STEAM - Steam 登录
 *   LoginEntryType.GUEST - 游客登录
 *   LoginEntryType.PHONE - 手机号登录
 *   LoginEntryType.EMAIL - 邮箱登录
 */
private void loginByType() {
    XDGAccount.loginByType(LoginActivity.this, LoginEntryType.TAP_TAP, new Callback<XDGUser>() {
        @Override
        public void onCallback(XDGUser xdgUser, XDGError xdgError) {
            if (xdgUser != null) {
                // 登录成功
                String userId = xdgUser.getId(); // 用户在 XD 账户系统的 XD User ID（用户唯一标识）
                String avatarUrl = xdgUser.getAvatar();
                String nickname = xdgUser.getNickName();
                return;
            }

            // 登录失败
            if (xdgError != null) {
                int code = xdgError.getCode();
                String message = xdgError.getMessage();
                Log.e("LoginActivity", "XDSDK loginFailed, code=" + code + ", message: " + message);
                Map<String, Object> errorDataMap = xdgError.getErrorDataMap();
                if (errorDataMap != null) {
                    // ...
                }
            }
        }
    });
}

主机登录​

我们可以把「Steam/PS/Nintendo」等平台上发行的游戏称之为主机游戏，对于这些游戏，用户们会更习惯用该平台账号登录游戏。对于这类游戏，推荐使用这个接口来登录。

游戏如何正确的使用该接口，可以参考这里的方案

XDGAccount.LoginByConsole(xdgUser => {
        ResultText.text = $"Steam 主机登录成功：{xdgUser.nickName} userId: {xdgUser.userId} kid: {xdgUser.token.kid}";
    }, null,
    error => {
        ResultText.text = $"Steam 主机登录失败：{error}";
    }
);

退出登录​

如果需要退出当前账号，可以使用该接口。调用后 SDK 会重新弹出协议窗口并在用户状态回调中返回 LOGOUT_CODE 事件。在玩家点击同意协议后会返回 PROTOCOL_AGREED_AFTER_LOGOUT_CODE 事件。

// LoginActivity.java

import com.xd.sdk.account.XDGAccount;

// ...

private void logout() {
    XDGAccount.logout(LoginActivity.this);
}

获取当前用户信息​

在用户已登录的情况下，调用此方法可获取当前已登录用户的信息：

// LoginActivity.java

import com.xd.sdk.account.XDGAccount;
import com.xd.sdk.common.bean.XDGUser;

// ...

private void getCurrentUser() {
    XDGUser currentUser = XDGAccount.getCurrentUser();
    if (currentUser != null) {
        String userId = currentUser.getId(); // 用户在 XD 账户系统的 XD User ID（用户唯一标识）
        String userName = currentUser.getName();
        String nickname = currentUser.getNickName();
        String avatar = currentUser.getAvatar();
    }
}

打开用户中心​

  • 需要登录
  • 用户中心会展示用户当前的登录类型，对应的账号 ID，以及当前绑定的一些第三方平台，可以操作绑定更多的渠道。
// LoginActivity.java

import com.xd.sdk.account.XDGAccount;

// ...

private void openUserCenter() {
    XDGAccount.openUserCenter(LoginActivity.this);
}

打开个人信息页​

  • 需要登录
  • 会展示游戏和 SDK 收集的和玩家个人信息相关的内容。
// LoginActivity.java

import com.xd.sdk.account.XDGAccount;
import com.xd.sdk.common.entities.RoleInfo;

// ...

private void openUserDashboard() {
    RoleInfo roleInfo = RoleInfo.newBuilder()
            .setRoleId("game_role_id") // 必填
            .setRoleName("game_role_name") // 必填
            .setRoleLevel(100)// 必填
            .setServerId("game_server_id") // 必填
            .setExtra("extra_info")
            .build();
    XDGAccount.openUserDashboard(LoginActivity.this, roleInfo);
}

打开帐户注销页面​

  • 需要登录
  • 用户可通过此方法进行帐户的注销操作。
  • 当用户成功发起注销且关闭当前页面时，会在用户状态回调中返回退出登录的事件，游戏需要同步退出登录状态。
  • 此时玩家账号还未真正被删除，需要参考服务端通知对接完成对接后收到通知时在游戏侧删除相应账号的数据。
// LoginActivity.java

import com.xd.sdk.account.XDGAccount;

// ...

private void openAccountDeletion() {
    XDGAccount.openAccountDeletion(LoginActivity.this);
}

打开客服页面​

  • 不需要登录
  • 未登录时 SDK 会自动处理成匿名游客身份进入客服页面，登录后 SDK 会自动切换成当前登录用户身份进入客服页面。
// MainActivity.java

import com.xd.sdk.account.XDGAccount;
import com.xd.sdk.common.entities.RoleInfo;

import java.util.HashMap;
import java.util.Map;

// ...

private void openCustomerService() {
    RoleInfo roleInfo = RoleInfo.newBuilder()
            .setRoleId("game_role_id") // 必填
            .setRoleName("game_role_name") // 必填
            .setRoleLevel(100)// 必填
            .setServerId("game_server_id") // 必填
            .setExtra("extra_info")
            .build();

    String path = ""; // 客服内的相对路径，一般留空即可

    Map<String, Object> extrasMap = new HashMap<>();
    extrasMap.put("key", "value");

    XDGAccount.openCustomerService(MainActivity.this, roleInfo, path, extrasMap);
}

绑定第三方账号​

危险

绑定接口对于玩家来说如果授权了和之前授权不一样的账号的话，存在「换绑」的可能性，所以游戏需要谨慎使用该方法，使用前需要给到用户明确的提醒。参考 绑定账号接口 文档。

// LoginActivity.java

import com.xd.sdk.account.XDGAccount;
import com.xd.sdk.common.base.XDGError;
import com.xd.sdk.common.callback.XDGBindResultCallback;
import com.xd.sdk.common.entities.LoginEntryType;

// ...

private void bindByType() {
    XDGAccount.bindByType(LoginActivity.this, LoginEntryType.GOOGLE, new XDGBindResultCallback() {
        @Override
        public void onBindResult(boolean success, XDGError error) {
            if (success) {
                // 绑定成功
            } else {
                // 绑定失败
                if (error!= null) {
                    int errorCode = error.getCode();
                    String errorMsg = error.getMessage();
                }
            }
        }
    });
}