登录相关功能

集成Google、Facebook、NAVER等各种登录SDK功能，可在GAMEPOT Unreal SDK中使用。

使用前设置

---

如要使用登录相关SDK功能，需完成控制台设置并声明登录相关代码。

设置Google登录环境

为使用登录功能，按以下方法设置Google Firebase控制台。

1. 将从Google Firebase控制台获取的Android专用google-service.json文件复制到$S(PluginDir)/ThirdParty/Android/路径下。

2. 将配置APK时使用的Keystore文件的SHA-1值添加到Firebase控制台。

   • 尝试Google登录时，如果onCancel响应并无法登录，请按以下方法解决。

     • 确认是否正常应用google-service.json文件

     • 确认配置APK时使用的Keystore和为注册到Firebase控制台导出SHA-1值的Keystore是否相同

     • 确认构建时是否使用了注册到Firebase控制台的包名称

3. AdditionalPlistData中添加Google相关CFBundleURLSchemes值

   <key>CFBundleURLTypes</key>
   <array>
   <dict>
   <key>CFBundleTypeRole</key>
   <string>Editor</string>
   <key>CFBundleURLSchemes</key>
   <array>
   <string>GoogleService-Info.plist文件中REVERSED_CLIENT_ID值，例如）com.googleusercontent.apps.XXXXXXXXX</string>
   </array>
   ...
   </dict>
   </dict>

设置Facebook登录环境

为使用登录功能，按以下方法设置Facebook控制台。

1. 在Facebook for Developers控制台将应用类型选择为None、Consumer或Gaming后创建应用。

2. 将配置APK时使用的Keystore的密钥哈希值添加到Facebook for Developers控制台。

3. 将从Facebook for Developers控制台获取的应用ID输入到下列代码后，添加到Android专用GamePot_Android_UPL.xml文件。

   ...
   <resourceCopies>
           <copyFile src="$S(PluginDir)/ThirdParty/Android/libs/gamepot-channel-facebook.aar" dst="$S(BuildDir)/libs/gamepot-channel-facebook.aar" />
   </resourceCopies>
   ...
   
   ...
   <buildGradleAdditions>
       <insert>
   
           ...
           dependencies {
               ...
               implementation(name: 'gamepot-channel-facebook', ext: 'aar')
               ...
           }
   
           ...
   
           defaultConfig {
               resValue "string", "facebook_app_id", "1234567890"
               resValue "string", "fb_login_protocol_scheme", "fb1234567890"
           }
           ...
   
       </insert>
   </buildGradleAdditions>
   
   ...
   
   <gameActivityImportAdditions>
     <insert>
       import io.gamepot.channel.facebook.GamePotFacebook;
     </insert>
   </gameActivityImportAdditions>

4. 将在GamepotConfig-info.plist 文件添加下列代码。

   gamepot_facebook_app_id// 从Facebook开发者控制台获取的应用ID

   用SourceCode查看时，如下进行添加

   ...
    <key>gamepot_facebook_app_id</key>
    <string>xxxxxx</string>
    ...

5. AdditionalPlistData中添加Facebook相关CFBundleURLSchemes及LSApplicationQueriesSchemes值

   <key>CFBundleURLTypes</key>
   <array>
   <dict>
   <key>CFBundleTypeRole</key>
   <string>Editor</string>
   <key>CFBundleURLSchemes</key>
   <array>
   <string>fb[Facebook应用ID]，例如）fb100001</string>
   </array>
   ...
   </dict>
   …..
   <key>LSApplicationQueriesSchemes</key>
   <array>
   <string>fbapi</string>
   <string>fb-messenger-api</string>
   <string>fb-messenger-share-api</string>
   <string>fbauth2</string>
   <string>fbshareextension</string>
   ……
   </array>

设置Apple登录环境

如要设置iOS专用Apple登录环境，请在项目的Config路径DefaultEngine.ini文件内的/Script/IOSRuntimeSettings.IOSRuntimeSettings项目中添加bEnableSignInWithAppleSupport=True flag值。

登录功能

如要使用根据开发商实现的登录UI点击登录按钮时操作的SDK登录功能，请使用下列代码。

将创建用于确认用户信息的MemberId，创建的信息保存到FNUserInfo后返回。

if (FGamePotSDKPluginModule::IsGamePotSdkAvailable())
FGamePotSDKPluginModule::GetSharedGamePotSdk()->Login(ENLoginType::Type loginType);

void ASampleGameModeBase::OnLoginSuccess(FNUserInfo NUserInfo)
{
    // 登录成功
}

void ASampleGameModeBase::OnLoginCancel()
{
    // 取消登录
}

void ASampleGameModeBase::OnLoginFailure(FNError NError)
{
   // 登录失败
    // 请使用NError.message显示错误消息。
}

// 维护（仪表盘的维护功能处于激活状态时调用）
void ASampleGameModeBase::OnLoginMaintenance(FNAppStatus NAppStatus)
{
   // 须基于参数传递的status信息创建并显示弹窗。请从下列两种方式中选择一种配置弹窗。
    // 方式1：使用开发商自行实现UI的游戏内弹窗
    // 方式2：调用下列代码后使用SDK自主弹窗
    IGamePotSdk* ptr = FGamePotSDKPluginModule::GetSharedGamePotSdk();
    if (FGamePotSDKPluginModule::IsGamePotSdkAvailable())
        ptr->showAppStatusPopup(NAppStatus.ToJsonString());
}

// 强制更新（商店版本和客户端版本不一致时调用）
void ASampleGameModeBase::OnLoginNeedUpdate(FNAppStatus NAppStatus)
{
     // 须基于参数传递的status信息创建并显示弹窗。请从下列两种方式中选择一种配置弹窗。
    // 方式1：使用开发商自行实现UI的游戏内弹窗
    // 方式2：调用下列代码后使用SDK自主弹窗
    IGamePotSdk* ptr = FGamePotSDKPluginModule::GetSharedGamePotSdk();
    if (FGamePotSDKPluginModule::IsGamePotSdkAvailable())
        ptr->showAppStatusPopup(NAppStatus.ToJsonString());
}

void ASampleGameModeBase::OnLoginExit()
{
   // 如果使用方式2实现强制更新或维护功能时，因有可能强制结束应用，请在此处可执行结束应用。
}

void ASampleGameModeBase::OnAppClose()
{
    // 结束应用
    // 如果使用方式2实现强制更新或维护功能时，因有可能强制结束应用，请在此处可执行结束应用。
}

定义LoginType、NUserInfo、NAppStatus

如要设置登录功能的各个参数，请使用下列代码。

• LoginType

  UENUM()
  namespace ENLoginType
  {
      enum Type
      {
          NONE,
          GOOGLE,
          GOOGLEPLAY,
          FACEBOOK,
          NAVER,
          GAMECENTER,
          TWITTER,
          LINE,
          APPLE,
          GUEST,
          THIRDPARTYSDK,
          STANDALONE
      };
  }

• NUserInfo

  USTRUCT()
  struct FNUserInfo
  {
      UPROPERTY()
      FString memberid;          // 组成人员ID（用户唯一ID）
      UPROPERTY()
      FString name;              // 姓名
      UPROPERTY()
      FString profileUrl;        // 头像URL（存在时）
      UPROPERTY()
      FString email;             // 邮件（如果有）
      UPROPERTY()
      FString token;             // 玩家有效性检查用Token（在Token Authentication API中使用）
      UPROPERTY()
      FString userid;            // 社交媒体ID
  }

• NAppStatus

  USTRUCT()
  struct FNAppStatus
  {
      UPROPERTY()
      FString type;      // 是AppStatus类型，"maintenance"为维护，"needupdate"为更新
  
      UPROPERTY()
      FString message;   // 维护设置：在仪表盘输入的消息
  
      UPROPERTY()
      FString url;       // 维护设置：在仪表盘输入的URL
  
      UPROPERTY()
      FString currentAppVersion; // 更新：当前的应用版本
  
      UPROPERTY()
      FString updateAppVersion;  // 更新：在仪表盘输入的应用版本
  
      UPROPERTY()
      int currentAppVersionCode; // 更新：当前的应用代码
  
      UPROPERTY()
      FString updateAppVersionCode;  // 更新：在仪表盘输入的应用版本代码
  
      UPROPERTY()
      bool isForce;      // 更新：在仪表盘设置强制更新时为true
  
      UPROPERTY()
      FString resultPayload; // 由客户端SDK传递的JSON值，可忽略。
  
      UPROPERTY()
      double startedAt;   // 维护：开始时间（时间戳）
  
      UPROPERTY()
      double endedAt;    // 维护：结束时间（时间戳）
  }

设置为获取IDFA值的权限请求弹窗

如要在iOS平台使用为获取用户IDFA值的权限请求弹窗时，请使用下列代码。

   if (FGamePotSDKPluginModule::IsGamePotSdkAvailable())
        FGamePotSDKPluginModule::GetSharedGamePotSdk()->requestTrackingAuthorization();

    void ASampleGameModeBase::OnSdkResultTrackingAuthorization(FNResultTrackingAuthorization info) {
        // info.authorization (FString)
        //        ATTrackingManagerAuthorizationStatusNotDetermined,
        //        ATTrackingManagerAuthorizationStatusRestricted,
        //        ATTrackingManagerAuthorizationStatusDenied,
        //        ATTrackingManagerAuthorizationStatusAuthorized,
        //        ATTrackingManagerAuthorizationStatusUnknown
    }

    // 可随机显示IDFA值获取权限请求弹窗。获取权限后，即使调用方法也不会弹出弹窗。

• 变更弹窗请求时间

  iOS平台获取IDFA值的权限请求弹窗，将在调用登录API时请求。如果不希望在登录时调用此弹窗，在$S(PluginDir)/Private/iOS/IOSGamePotSdk.cpp文件如下修改函数。

  void FIOSGamePotSdk::Login(ENLoginType::Type _loginType)
  {
      //在登录前阶段明确显示IDFA权限请求弹窗<-- 必要时，做注释处理
      FIOSGamePotSdk::requestTrackingAuthorization();
      ...

使用第三方账户登录功能

---

如要使用第三方账户登录功能，请使用下列代码应用设置。

NAVER登录

如要使用NAVER登录功能，需在NAVER Developers控制台将使用API选择为NAVER ID登录后注册应用并使用下列代码。

• Android

  • 修改 GamePot_Android_UPL.xml

    ...
    <resourceCopies>
            <copyFile src="$S(PluginDir)/ThirdParty/Android/libs/gamepot-channel-naver.aar" dst="$S(BuildDir)/libs/gamepot-channel-naver.aar" />
    </resourceCopies>
    
    ...
    
    <buildGradleAdditions>
        <insert>
    
            ...
            dependencies {
                ...
                implementation(name: 'gamepot-channel-naver', ext: 'aar')
                ...
            }
    
            ...
    
            defaultConfig {
                resValue "string", "gamepot_naver_clientid", "abcdefg1234567890"
                resValue "string", "gamepot_naver_secretid", "hijklmn"
            }
            ...
    
        </insert>
    </buildGradleAdditions>
    
    ...
    
    <gameActivityImportAdditions>
      <insert>
        import io.gamepot.channel.naver.GamePotNaver;
      </insert>
    </gameActivityImportAdditions>
    
    ...

  • 将从NAVER开发者控制台获取的Client ID输入到gamepot_naver_clientid值中，将Client Secret输入到gamepot_naver_secretid值中

  • 在$S(PluginDir)ThirdParty/Android/libs项目路径下添加gamepot-channel-naver.aar文件

• iOS

  • 修改 GamePotSDKPlugin.Build.cs文件

    ...
    
    public GamePotSDKPlugin(ReadOnlyTargetRules Target) : base(Target)
    {
        ...
               else if (Target.Platform == UnrealTargetPlatform.IOS)
            {
                    PublicAdditionalFrameworks.Add(
                    new Framework(
                        "GamePotNaver",
                        ModuleDirectory+"/ThirdParty/iOS/GamePotNaver.framework"
                    )
                );
    
                    PublicAdditionalFrameworks.Add(
                    new Framework(
                        "NaverThirdPartyLogin",
                        ModuleDirectory+"/ThirdParty/iOS/NaverThirdPartyLogin.framework"
                    )
            }
        ...
    }
    ...

  • 修改 GamePotConfig-info.plist文件

     gamepot_naver_clientid// 拟在NAVER使用的Client ID
     gamepot_naver_secretid// 拟在NAVER使用的Secret ID
     gamepot_naver_urlscheme// 拟在NAVER使用的URL Scheme

    用SourceCode查看时，如下进行添加

    ...
    <key>gamepot_naver_clientid</key>
    <string>xxxxxx</string>
    <key>gamepot_naver_secretid</key>
    <string>xxxxxx</string>
    <key>gamepot_naver_urlscheme</key>
    <string>xxxxxx</string>
    ...

    AdditionalPlistData中添加NAVER相关CFBundleURLSchemes及LSApplicationQueriesSchemes值

    <key>CFBundleURLTypes</key>
    <array>
    <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <key>CFBundleURLSchemes</key>
    <array>
    <string>NAVER控制台中设置的IOS Schemes值</string>
    </array>
    ...
    </dict>
    …..
    <key>LSApplicationQueriesSchemes</key>
    <array>
    <string>naversearchapp</string>
    <string>naversearchthirdlogin</string>
    <string>navercafe</string>
    ……
    </array>

LINE登录

如要使用LINE登录功能，需将配置APK时使用的包名称、Keystore的SHA-1值、URL Scheme值添加到LINE Developers控制台后使用下列代码。

• Android

  • 修改 GamePot_Android_UPL.xml

    ...
    <resourceCopies>
        <copyFile src="$S(PluginDir)/ThirdParty/Android/libs/gamepot-channel-line.aar" dst="$S(BuildDir)/libs/gamepot-channel-line.aar" />
        <copyFile src="$S(PluginDir)/ThirdParty/Android/libs/line-sdk-4.0.10.aar" dst="$S(BuildDir)/libs/line-sdk-4.0.10.aar" />
    </resourceCopies>
    
    ...
    
    <buildGradleAdditions>
        <insert>
    
            ...
            dependencies {
                ...
                implementation(name: 'gamepot-channel-line', ext: 'aar')
                implementation(name: 'line-sdk-4.0.10', ext: 'aar')
                ...
            }
    
            ...
    
            defaultConfig {
                resValue "string", "gamepot_line_channelid","xxxxxxx"
            }
            ...
    
        </insert>
    </buildGradleAdditions>
    
    ...
    
    <gameActivityImportAdditions>
      <insert>
        import io.gamepot.channel.line.GamePotLine;
      </insert>
    </gameActivityImportAdditions>
    
    ...

  • 在$S(PluginDir)/ThirdParty/Android/libs项目路径下添加gamepot-channel-line.aar文件和line-sdk-4.0.10.aar文件

• iOS

  • 修改 GamePotSDKPlugin.Build.cs文件

    ...
    
    public GamePotSDKPlugin(ReadOnlyTargetRules Target) : base(Target)
    {
        ...
               else if (Target.Platform == UnrealTargetPlatform.IOS)
            {
                    PublicAdditionalFrameworks.Add(
                    new Framework(
                        "GamePotLine",
                        ModuleDirectory+"/ThirdParty/iOS/GamePotLine.framework"
                    )
                );
    
                PublicAdditionalFrameworks.Add(
                    new Framework(
                        "LineSDK",
                        ModuleDirectory+"/ThirdParty/iOS/LineSDK.framework"
                    )
                );
    
                PublicAdditionalFrameworks.Add(
                    new Framework(
                        "LineSDKObjC",
                        ModuleDirectory+"/ThirdParty/iOS/LineSDKObjC.framework"
                    )
                );
            }
        ...
    }
    ...

  • 修改GamePotConfig-info.plist文件

      gamepot_line_channelid// 拟在NAVER使用的Client ID
      gamepot_line_url_schemes// LINE URL Scheme（line3rdp.{项目包identifier}）

    用SourceCode查看时，如下进行添加

    ...
    <key>gamepot_line_channelid</key>
    <string>xxxxxx</string>
    <key>gamepot_line_url_schemes</key>
    <string>xxxxxx</string>
    ...

    AdditionalPlistData中添加LINE相关CFBundleURLSchemes及LSApplicationQueriesSchemes值

    <key>CFBundleURLTypes</key>
    <array>
    <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <key>CFBundleURLSchemes</key>
    <array>
    <string>line3rdp.{项目捆绑标识符}<</string>
    </array>
    ...
    </dict>
    …..
    <key>LSApplicationQueriesSchemes</key>
    <array>
    <string>lineauth2</string>
    ……
    </array>

Apple Web登录

如要使用Apple Web登录，在仪表盘的项目设置 > 一般菜单设置Apple ID登录后使用下列代码。

• 修改GamePot_Android_UPL.xml

  ...
  <resourceCopies>
          <copyFile src="$S(PluginDir)/ThirdParty/Android/libs/gamepot-channel-apple-signin.aar" dst="$S(BuildDir)/libs/gamepot-channel-apple-signin.aar" />
  </resourceCopies>
  
  ...
  
  <buildGradleAdditions>
      <insert>
  
          ...
          dependencies {
              ...
              implementation(name: 'gamepot-channel-apple-signin', ext: 'aar')
              ...
          }
  
          ...
  
      </insert>
  </buildGradleAdditions>
  
  ...
  
  <gameActivityImportAdditions>
    <insert>
      import io.gamepot.channel.naver.GamePotAppleSignin;
    </insert>
  </gameActivityImportAdditions>
  
  ...

• 向项目$S(PluginDir)/ThirdParty/Android/libs路径添加gamepot-channel-apple-signin.aar文件

自动登录功能

---

如要使用通过传输会员最后一次登录信息的API自动登录功能时，请使用下列代码。

ENLoginType::Type loginType =  FGamePotSDKPluginModule::GetSharedGamePotSdk()->getLastLoginType();

if(loginType != ENLoginType::NONE) {
{
    // 以最后一次登录的类型登录的方式。
    FGamePotSDKPluginModule::GetSharedGamePotSdk()->Login(loginType);
}
else
{
    // 第一次运行游戏或已退出登录的状态。请跳转到可以进行登录的登录界面。
}

退出功能

---

如要使用退出功能，请使用下列代码。

if (FGamePotSDKPluginModule::IsGamePotSdkAvailable())
    FGamePotSDKPluginModule::GetSharedGamePotSdk()->Logout();

void ASampleGameModeBase::OnLogoutSuccess()
{
}

void ASampleGameModeBase::OnLogoutFailure(FNError NError)
{
    // 退出登录失败。请使用NError.message显示错误消息。
}

会员注销功能

---

如要使用会员注销功能，请使用下列代码。

if (FGamePotSDKPluginModule::IsGamePotSdkAvailable())
    FGamePotSDKPluginModule::GetSharedGamePotSdk()->deleteMember();

/// 会员注销成功
void ASampleGameModeBase::OnDeleteMemberSuccess()
{

}

void ASampleGameModeBase::OnDeleteMemberFailure(FNError NError)
{
   // 会员注销失败。请使用NError.message显示错误消息。
}

登录验证功能

登录成功并由开发商服务器向GAMEPOT服务器传递登录信息后，即可进行登录验证。

详细说明请参考登录验证请求。