Provides HIVE SDK initialization and HIVE authentication functions
The HIVE SDK performs initialization based on the xml configuration file.
More...
Classes | |
| class | AuthV4MaintenanceExtraButton |
| Button information for customizing the maintenance popup action : Actions to be taken when the button is pressed url : URL to be browsed when action is OPEN_URL button : Text on the button ex) OK More... | |
| class | AuthV4MaintenanceInfo |
| Server Maintenance and Update status display information title : Title message : Contents button : Text on the button ex) OK action : Actions to be taken when the button is pressed url : URL to be browsed when action is OPEN_URL remainingTime : When action is EXIT, the time in seconds remaining until the maintenance completes. More... | |
| class | ParentalConsentInfo |
| Parental Consent Information It includes the user's date of birth and the guardian's email address. More... | |
| class | PlayerInfo |
| Sign-in User Information it includes user's tocken and DID value along with ProfileInfo. More... | |
| class | ProfileInfo |
| User Profile Information playerID : User's unique ID playerName : The nickname of the user to be shown outside. More... | |
| class | ProviderInfo |
| Identity Provider (IdP) Information It contains the UserId of the associated Identity Provider. More... | |
Public Types | |
| enum | ProviderType |
| Provider Types AUTO is for Automatic Login If the result of isAutoSignIn() call is true, You need to set parameter as AUTO when you call SignIn. More... | |
| enum | AuthV4MaintenanceActionType |
| Actions to be taken when a button is pressed on the maintenance popup. More... | |
Public Member Functions | |
| delegate void | onAuthV4Setup (ResultAPI result, Boolean isAutoSignIn, String did, List< ProviderType > providerTypeList) |
| AuthV4 initialization result callback result : When initial initialize is executed, it fails if it does not receive DID or Provider List. More... | |
| delegate void | onAuthV4SignIn (ResultAPI result, PlayerInfo playerInfo) |
| AuthV4 Sign-in result callback result : If it is not SUCCESS, you should return to the login screen again. More... | |
| delegate void | onAuthV4SignOut (ResultAPI result) |
| AuthV4 Sign out result callback result : If setup fails (NEED_INITIALIZE) or SignIn or SignOut is in progress (IN_PROGRESS), it may fail. Otherwise, success. More... | |
| delegate void | onAuthV4Connect (ResultAPI result, PlayerInfo conflictPlayer) |
| AuthV4 Provider connect result callback result :If ProviderType is not supported (INVALID_PARAM) or if the Sign-in is in progress (IN_PROGRESS), it may fail. More... | |
| delegate void | onAuthV4Disconnect (ResultAPI result) |
| AuthV4 Provider disconnect result callback It pass the disconnect status to the authentication server and then logout the requested provider. More... | |
| delegate void | onAuthV4GetProfile (ResultAPI result, List< ProfileInfo > profileInfoList) |
| AuthV4 Profile information request result callback The profile information of the playerIds which are requested to the profile server is returned. More... | |
| delegate void | onAuthV4ShowProfile (ResultAPI result) |
| AuthV4 Profile UI request result callback Invoked when the UI window is closed. More... | |
| delegate void | onAuthV4ShowInquiry (ResultAPI result) |
| AuthV4 1:1 Inquiry UI request result callback Invoked when the UI window is closed. More... | |
| delegate void | onAuthV4ShowMyInquiry (ResultAPI result) |
| AuthV4 My Inquiry UI request result callback Invoked when the UI window is closed. More... | |
| delegate void | onAuthV4ShowChatbotInquiry (ResultAPI result) |
| AuthV4 Chatbot 1:1 Inquiry UI request result callback Invoked when the UI window is closed. More... | |
| delegate void | onAuthV4ShowTerms (ResultAPI result) |
| AuthV4 Terms of Service UI request result callback Invoked when the UI window is closed. More... | |
| delegate void | onAuthV4AdultConfirm (ResultAPI result) |
| AuthV4 Adult authentication request result callback Invoked when the UI window is closed. More... | |
| delegate void | onDeviceProviderInfo (ResultAPI result, ProviderInfo providerInfo) |
| AuthV4 Provider status request result callback If the requested provider is not logged in, it tries to login. More... | |
| delegate void | onAuthV4Maintenance (ResultAPI result, List< AuthV4MaintenanceInfo > maintenanceInfoList) |
| AuthV4 Sever maintenance check request result callback Check whether the server is in the server maintenance with the ServerId set in Configuration. More... | |
| delegate void | onGetProviderFriendsList (ResultAPI result, ProviderType providerType, Dictionary< String, Int64 > providerUserIdList) |
| HIVE SDK Provider friend list request result callback result : Result of API. More... | |
| delegate void | onAuthV4ResolveConflict (ResultAPI result) |
Result callback of resolveConflict(AuthV4ResolveConflictListener) call AuthV4.resolveConflict() use it. More... | |
| delegate void | onAuthV4ShowDeviceManagement (ResultAPI result) |
showDeviceManagement(AuthV4ShowDeviceManagementListener) call AuthV4.showDeviceManagement() use it. More... | |
| delegate void | onAuthV4RefreshAccessToken (ResultAPI result, string accessToken) |
refreshAccessToken(onAuthV4RefreshAccessToken) call AuthV4.refreshAccessToken() use it. More... | |
| delegate void | onAuthV4DialogDismiss (bool isDismiss) |
| AuthV4 Result callback after Game Center login pops up More... | |
| delegate void | onAuthV4GetAccountPlayerIdList (ResultAPI result, List< Int64 > playerId) |
| Callback type definition for player ID retrieval Defines the callback function type for handling player ID retrieval results. More... | |
| delegate void | onAuthV4StorePlayerId (ResultAPI result) |
| Callback type definition for saving the current logged-in session Defines the callback function type for handling the result of saving the current logged-in session. More... | |
| delegate void | onAuthV4DeletePlayerId (ResultAPI result) |
| Callback type definition for session information removal Defines the callback function type for handling session information removal results. More... | |
Static Public Member Functions | |
| static void | setup (onAuthV4Setup listener) |
| AuthV4 Perform initialization. More... | |
| static void | signIn (ProviderType providerType, onAuthV4SignIn listener) |
| Requests signIn according to the given providerType. More... | |
| static void | signInWithAuthKey (String authKey, onAuthV4SignIn listener) |
| Requests signIn with authKey gained from customized provider login implementation. More... | |
| static void | signOut (onAuthV4SignOut listener) |
| it remove the local session. More... | |
| static void | playerDelete (onAuthV4SignOut listener) |
| Delete the account and remove the local session. More... | |
| static void | connect (ProviderType providerType, onAuthV4Connect listener) |
| It connects to the currently requested provider for the currently signed-in user. More... | |
| static void | connectWithAuthKey (String authKey, onAuthV4Connect listener) |
Requests connect with authKey gained from customized provider login implementation. More... | |
| static void | disconnect (ProviderType providerType, onAuthV4Disconnect listener) |
| Releases the currently signed-in user from the requested provider. More... | |
| static void | disconnectWithName (String providerName, onAuthV4Disconnect listener) |
Releases the currently signed-in user from the requested provider. More... | |
| static void | selectConflict (Int64 selectedPlayerId, onAuthV4SignIn listener) |
| When an account conflict (CONFLICT_PLAYER) occurs due to connect, it notify the selected user to the SDK. More... | |
| static Boolean | isAutoSignIn () |
| It returns whether signIn (AUTO) is enabled. More... | |
| static PlayerInfo | getPlayerInfo () |
| It returns information about the currently signed-in user. More... | |
| static void | getProfile (List< Int64 > playerIdList, onAuthV4GetProfile listener) |
| it returns the profile information of the requested playerIds. More... | |
| static void | showSignIn (onAuthV4SignIn listener) |
| It shows the UI with a list of providers that can sign-in. More... | |
| static void | showConflictSelection (JSONObject currentPlayerData, JSONObject conflictPlayerData, onAuthV4SignIn listener) |
| It shows UI to select user in conflict state. More... | |
| static void | showProfile (Int64 playerId, onAuthV4ShowProfile listener) |
| It display the profile UI of the requested playerId. More... | |
| static void | showInquiry (onAuthV4ShowInquiry listener) |
| It shows the 1: 1 query UI. More... | |
| static void | showMyInquiry (onAuthV4ShowMyInquiry listener) |
| It shows the my inquiry UI. More... | |
| static void | showChatbotInquiry (String additionalInfo, onAuthV4ShowChatbotInquiry listener) |
| Show HIVE Chatbot 1:1 inquiry More... | |
| static void | showTerms (onAuthV4ShowTerms listener) |
| It shows HIVE Terms and Conditions. More... | |
| static void | resetAgreement () |
| Initialize the terms agreement record. | |
| static void | showAdultConfirm (onAuthV4AdultConfirm listener) |
| It request adult authentication. More... | |
| static void | checkProvider (ProviderType providerType, onDeviceProviderInfo listener) |
| It check the status of the requested Provider. More... | |
| static void | checkMaintenance (Boolean isShow, onAuthV4Maintenance listener) |
| It display maintenance status and return its data. More... | |
| static void | checkBlacklist (Boolean isShow, onAuthV4Maintenance listener) |
| it check the restriction status of the current user. More... | |
| static void | setProviderChangedListener (onDeviceProviderInfo listener) |
| It set a listener to be notified whether the information of the linked Provider has changed. More... | |
| static Boolean | getAgeGateU13 () |
| Return the value whether COPPA limits users under 13 or not. More... | |
| static void | getProviderFriendsList (ProviderType providerType, onGetProviderFriendsList listener) |
| It returns the playerId list information of the friends of the connected user corresponding to the input providerType. More... | |
| static void | resolveConflict (onAuthV4ResolveConflict listener) |
| It resolve the account conflicts(CONFLICT_PLAYER) caused by connect() call. More... | |
| static void | showDeviceManagement (onAuthV4ShowDeviceManagement listener) |
| Run the device management service. More... | |
| static void | refreshAccessToken (onAuthV4RefreshAccessToken listener) |
refreshAccessToken(onAuthV4RefreshAccessToken) call AuthV4.refreshAccessToken() use it. More... | |
| static void | requestPermissionViewData (onAuthV4RequestPermissionViewData listener) |
| 권한고지 팝업을 구성하기 위한 데이터를 얻습니다. More... | |
| static void | showGameCenterLoginCancelDialog (onAuthV4DialogDismiss listener) |
| If a sign-in window of Game Center is not displayed, show its status and display a UI to inform how to sign in the Game Center. | |
| static void | signInWithStoredPlayerId (Int64 playerId, Boolean useAutoSignIn, onAuthV4SignIn listener) |
| Requests login using PlayerID. More... | |
| static void | getStoredPlayerIdList (onAuthV4GetAccountPlayerIdList listener) |
| Returns the list of saved player IDs. More... | |
| static void | storeCurrentPlayerId (onAuthV4StorePlayerId listener) |
| Saves the current logged-in session. More... | |
| static void | deleteStoredPlayerId (Int64 playerId, onAuthV4DeletePlayerId listener) |
| Deletes the saved session information. More... | |
| static ParentalConsentInfo | getParentalConsentInfo () |
| Returns the parent consent information. More... | |
Provides HIVE SDK initialization and HIVE authentication functions
The HIVE SDK performs initialization based on the xml configuration file.
The detailed functions provided by this class are as follows.
Created by hife on 2017. 3. 22
| delegate void hive.AuthV4.onAuthV4DialogDismiss | ( | bool | isDismiss | ) |
AuthV4 Result callback after Game Center login pops up
| isDismiss | : Returns true if the popup is successfully closed. |