Checking User Data

You can check user’s profiles and suspended status after users signed in.

Getting User Profile

When user signs in Hive, you can get the user profile data by calling getProfile() method of AuthV4 class. Profile data contains playerId, playerName for display name, and playerImageUrl for user thumbnail image.

Followings are sample codes to receive profile data.

Checking Blacklist

When user signs in or syncs with IdP, Hive automatically checks the blacklist and suspends the user from playing game. If you need to check the status of user suspension during the game, use the checkBlacklist() method to check the suspended status of the user in real time and restrict the game play. Depending on the value of the isShow parameter at the time of checkBlacklist() call, Hive will either show the suspended status popup directly or return popup content for customizing the suspended status popup.

• Useing Hive-providing suspension popups: Set isShow parameter as true.
• Using Customized suspension popups: Set isShow parameter as false. For more information about popup data, see suspension popup Data Returned by Hive below.

• Example screen of suspension popup
  

Suspension Popup Data Returned by Hive

If the result of calling checkBlacklist() method is success, Hive returns the values in the following table through AuthV4MaintenanceInfo object.

Field Name	Description	Type
title	Popup title	String
message	Popup contents	String
button	Text on the label of popup button	String
action	Action type when a user taps the popup button OPEN_URL: Execute URL passed by external browser EXIT: End the app DONE: Just close maintenance popup	Enumeration type of AuthV4MaintenanceActionType
url	URL displayed by external browser. This is valid when the value of action field is OPEN_URL	String
remainingTime	Remaining time until maintenance completion (Unit: second). Time refreshes in real time and when it becomes zero, app is terminated.	Integer

Followings are sample codes to check the users under suspension.

• In case of using no Hive SDK UI (isShow = false)
  Unity®

  API Reference: hive.AuthV4.checkBlacklist

  using hive; Boolean isShow = false; AuthV4.checkBlacklist(isShow, (ResultAPI result, List<AuthV4.MaintenanceInfo> maintenanceInfo) => { if (!result.isSuccess()) { // Request to check for suspension failed return; } if(maintenanceInfo != null){ // In case of suspended user } else{ // If you are a general user } });

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

  using hive;   Boolean isShow = false; AuthV4.checkBlacklist(isShow, (ResultAPI result, List<AuthV4.MaintenanceInfo> maintenanceInfo) => {      if (!result.isSuccess()) {          // Request to check for suspension failed         return;      }          if(maintenanceInfo != null){          // In case of suspended user      } else{          // If you are a general user      } });

  C++

  API Reference: AuthV4::checkBlacklist

  #include <HIVE_SDK_Plugin/HIVE_CPP.h> using namespace std; using namespace hive; bool isShow = false; AuthV4::checkBlacklist(isShow, [=](ResultAPI const & result, vector<AuthV4MaintenanceInfo> const & maintenanceInfo) { if(!result.isSuccess) { // Request to check for suspension failed return; } if (maintenanceInfo != null){ // In case of suspended user } else { // If you are a general user } });

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

  #include <HIVE_SDK_Plugin/HIVE_CPP.h> using namespace std; using namespace hive;   bool isShow = false;   AuthV4::checkBlacklist(isShow, [=](ResultAPI const & result, vector<AuthV4MaintenanceInfo> const & maintenanceInfo) {      if(!result.isSuccess) {          // Request to check for suspension failed         return;      }        if (maintenanceInfo != null){          // In case of suspended user      } else {          // If you are a general user      } });

  Kotlin

  API Reference: AuthV4.checkBlacklist

  import com.hive.AuthV4 import com.hive.ResultAPI val isShow = false AuthV4.checkBlacklist(isShow, object : AuthV4.AuthV4MaintenanceListener { override fun onAuthV4Maintenance(result: ResultAPI, maintenanceInfo: ArrayList<AuthV4.AuthV4MaintenanceInfo>?) { if (!result.isSuccess) { // Request to check for suspension failed return } if (maintenanceInfo != null) { // In case of suspended user } else { // If you are a general user } } })

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

  import com.hive.AuthV4 import com.hive.ResultAPI   val isShow = false   AuthV4.checkBlacklist(isShow, object : AuthV4.AuthV4MaintenanceListener {      override fun onAuthV4Maintenance(result: ResultAPI, maintenanceInfo: ArrayList<AuthV4.AuthV4MaintenanceInfo>?) {          if (!result.isSuccess) {              // Request to check for suspension failed              return          }            if (maintenanceInfo != null) {              // In case of suspended user          } else {              // If you are a general user          }      } })

  Java

  API Reference: com.hive.AuthV4.checkBlacklist

  import com.hive.AuthV4; import com.hive.ResultAPI; boolean isShow = false; AuthV4.INSTANCE.checkBlacklist(isShow, (result, maintenanceInfo) -> { if (!result.isSuccess()) { // Request to check for suspension failed return; } if (maintenanceInfo != null) { // In case of suspended user } else { // If you are a general user } });

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  import com.hive.AuthV4; import com.hive.ResultAPI;   boolean isShow = false;   AuthV4.INSTANCE.checkBlacklist(isShow, (result, maintenanceInfo) -> {      if (!result.isSuccess()) {          // Request to check for suspension failed          return;      }        if (maintenanceInfo != null) {          // In case of suspended user      } else {          // If you are a general user      } });

  Swift

  API Reference: AuthV4Interface.checkBlacklist

  import HIVEService let isShow = false AuthV4Interface.checkBlacklist(isShow) { result, maintenanceInfo in if !result.isSuccess() { // Request to check for suspension failed return } if let maintenanceInfo = maintenanceInfo { // In case of suspended user } else { // If you are a general user } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

  import HIVEService   let isShow = false   AuthV4Interface.checkBlacklist(isShow) { result, maintenanceInfo in     if !result.isSuccess() {     // Request to check for suspension failed         return     }       if let maintenanceInfo = maintenanceInfo {     // In case of suspended user     } else {     // If you are a general user     } }

  Objective-C

  API Reference: HIVEAuthV4:checkBlacklist

  #import <HIVEService/HIVEService-Swift.h> BOOL isShow = NO; [HIVEAuthV4 checkBlackList: isShow handler: ^(HIVEResultAPI *result, HIVEAuthV4MaintenanceInfo *maintenanceInfo) { if (![result isSuccess]) { // Request to check for suspension failed return; } if (maintenanceInfo != nil) { // In case of suspended user } else { // If you are a general user } }];

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

  #import <HIVEService/HIVEService-Swift.h>   BOOL isShow = NO;   [HIVEAuthV4 checkBlackList: isShow handler: ^(HIVEResultAPI *result, HIVEAuthV4MaintenanceInfo *maintenanceInfo) {     if (![result isSuccess]) {     // Request to check for suspension failed     return;     }       if (maintenanceInfo != nil) {     // In case of suspended user     } else {     // If you are a general user     } }];

• In case of using Hive SDK UI (isShow = true)
  
  Unity®

  API Reference: hive.AuthV4.checkBlacklist

  // If isShow is true, Hive SDK displays suspension popup. Boolean isShow = true; // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4.checkBlacklist(isShow, (ResultAPI result, List<AuthV4.MaintenanceInfo> maintenanceInfo)=>{ if (result.isSuccess()) { // In case of normal user } else if (result.needExit()) { // TODO: Implement the termination of the app. // Example) Application.Quit(); }});

  1 2 3 4 5 6 7 8 9 10

  // If isShow is true, Hive SDK displays suspension popup. Boolean isShow = true;      // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4.checkBlacklist(isShow, (ResultAPI result, List<AuthV4.MaintenanceInfo> maintenanceInfo)=>{     if (result.isSuccess()) {         // In case of normal user     }    else if (result.needExit()) {         // TODO: Implement the termination of the app.         // Example) Application.Quit();    }});

  C++

  API Reference: AuthV4::checkBlacklist

  // If isShow is true, Hive SDK displays suspension popup. bool isShow = true; // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4::checkBlacklist(isShow, [=](ResultAPI const & result,std::vector<AuthV4MaintenanceInfo> const & maintenanceInfolist){ if (result.isSuccess()) { // In case of normal user } else if (result.needExit()) { // TODO: Implement the termination of the app. // Users of the Cocos2d-x engine // ex) exit(0); // Unreal engine users // Example) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false); }});

  1 2 3 4 5 6 7 8 9 10 11 12 13

  // If isShow is true, Hive SDK displays suspension popup. bool isShow = true;      // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4::checkBlacklist(isShow,  [=](ResultAPI const & result,std::vector<AuthV4MaintenanceInfo> const & maintenanceInfolist){     if (result.isSuccess()) {         // In case of normal user     }    else if (result.needExit()) {         // TODO: Implement the termination of the app.         // Users of the Cocos2d-x engine         // ex) exit(0);         // Unreal engine users         // Example) UKismetSystemLibrary::QuitGame(GetWorld(), nullptr, EQuitPreference::Quit, false);    }});

  Kotlin

  API Reference: com.hive.AuthV4.checkBlacklist

  // If isShow is true, Hive SDK displays suspension popup. val isShow = true // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4.checkBlacklist(isShow, object : AuthV4.AuthV4MaintenanceListener { override fun onAuthV4Maintenance( result: ResultAPI, maintenanceInfo: ArrayList<AuthV4.AuthV4MaintenanceInfo>? ) { if (result.isSuccess) { // In case of normal user } else if (result.needExit()) { // TODO: Implement the termination of the app. // Example) exitProcess(0) } }})

  1 2 3 4 5 6 7 8 9 10 11 12

  // If isShow is true, Hive SDK displays suspension popup. val isShow = true      // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4.checkBlacklist(isShow, object : AuthV4.AuthV4MaintenanceListener {     override fun onAuthV4Maintenance(         result: ResultAPI,         maintenanceInfo: ArrayList<AuthV4.AuthV4MaintenanceInfo>?    ) {        if (result.isSuccess) {             // In case of normal user         } else if (result.needExit()) {             // TODO: Implement the termination of the app.             // Example) exitProcess(0)        }    }})

  Java

  API Reference: com.hive.AuthV4.checkBlacklist

  // If isShow is true, Hive SDK displays suspension popup. boolean isShow = true; // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4.checkBlacklist(isShow, new AuthV4.AuthV4MaintenanceListener() { @Override public void onAuthV4Maintenance(ResultAPI result, ArrayList<AuthV4.AuthV4MaintenanceInfo> maintenanceInfo) { if (result.isSuccess()) { // In case of normal user } else if (result.needExit()) { // TODO: Implement the termination of the app. // Example) System.exit(0); } }});

  1 2 3 4 5 6 7 8 9 10 11 12

  // If isShow is true, Hive SDK displays suspension popup. boolean isShow = true;      // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4.checkBlacklist(isShow, new AuthV4.AuthV4MaintenanceListener() {     @Override     public void onAuthV4Maintenance(ResultAPI result, ArrayList<AuthV4.AuthV4MaintenanceInfo> maintenanceInfo) {         if (result.isSuccess()) {             // In case of normal user         }        else if (result.needExit()) {             // TODO: Implement the termination of the app.             // Example) System.exit(0);        }    }});

  Swift

  API Reference: HIVEAuthV4:checkBlacklist

  // If isShow is true, Hive SDK displays suspension popup. let isShow = true // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4Interface.checkBlacklist(isShow) { (result, maintenanceInfolist) in if result.isSuccess() { // In case of normal user } else if result.needExit() { // TODO: Implement the termination of the app. // Example) exit(0) } }

  1 2 3 4 5 6 7 8 9 10 11 12 13

  // If isShow is true, Hive SDK displays suspension popup. let isShow = true // Hive SDK AuthV4 requests to check whether suspended user or not. AuthV4Interface.checkBlacklist(isShow) { (result, maintenanceInfolist) in     if result.isSuccess() {         // In case of normal user     }     else if result.needExit() {         // TODO: Implement the termination of the app.         // Example) exit(0)     } }

  Obj-C

  API Reference: HIVEAuthV4:checkBlacklist

  // If isShow is YES, Hive SDK displays suspension popup. BOOL isShow = YES; // Hive SDK AuthV4 requests to check whether suspended user or not. [HIVEAuthV4 checkBlacklist:isShow handler:^(HIVEResultAPI *result, NSArray<HIVEAuthV4MaintenanceInfo *> *maintenanceInfolist) { if (result.isSuccess) { // In case of normal user } else if (result.needExit) { // TODO: Implement the termination of the app. // Example) exit(0); }}];

  1 2 3 4 5 6 7 8 9 10

  // If isShow is YES, Hive SDK displays suspension popup. BOOL isShow = YES;    // Hive SDK AuthV4 requests to check whether suspended user or not. [HIVEAuthV4 checkBlacklist:isShow handler:^(HIVEResultAPI *result, NSArray<HIVEAuthV4MaintenanceInfo *> *maintenanceInfolist) {     if (result.isSuccess) {         // In case of normal user     }    else if (result.needExit) {         // TODO: Implement the termination of the app.         // Example) exit(0);             }}];

Use the email address of users

After calling the Explicit Login API, you can get the email address of a logged-in user via referencing providerInfoData in PlayerInfo class instance, which is returned in the callback.

Use ProviderType as the key in providerInfoData to get the ProviderInfo. For more details, see the example codes below.