HIVE SDK for Unreal Engine

HiveAuthV4.h
Go to the documentation of this file.
1
41#pragma once
42
43#include "CoreMinimal.h"
44#include "Impl/HiveAuthV4Impl.h"
45#include "Impl/HiveAuthV4HelperImpl.h"
46
47HIVESDK_API IHiveAuthV4Impl* GetAuthV4Instance();
48HIVESDK_API IHiveAuthV4HelperImpl* GetAuthV4HelperInstance();
49
83class HIVESDK_API FHiveAuthV4
84{
85public:
126 static void Setup(const FHiveAuthV4OnSetupDelegate& Delegate);
127
174 static void SignIn(const EHiveProviderType& ProviderType, const FHiveAuthV4OnSignInDelegate& Delegate);
175
194 static void SignInWithAuthKey(const FString& AuthKey, const FHiveAuthV4OnSignInDelegate& Delegate);
195
217 static void SignOut(const FHiveAuthV4OnSignOutDelegate& Delegate);
218
240 static void PlayerDelete(const FHiveAuthV4OnSignOutDelegate& Delegate);
241
308 static void Connect(const EHiveProviderType& ProviderType, const FHiveAuthV4OnConnectDelegate& Delegate);
309
345 static void Disconnect(const EHiveProviderType& ProviderType, const FHiveAuthV4OnDisconnectDelegate& Delegate);
346
396 static void ConnectWithAuthKey(const FString& AuthKey, const FHiveAuthV4OnConnectDelegate& Delegate);
397
433 static void DisconnectWithName(const FString& ProviderName, const FHiveAuthV4OnDisconnectDelegate& Delegate);
434
467 static void SelectConflict(int64 SelectedPlayerId, const FHiveAuthV4OnSignInDelegate& Delegate);
468
502 static void ShowConflictSelection(const FHiveConflictViewData& ConflictViewData, const FHiveAuthV4OnSignInDelegate& Delegate);
503
538 static void CheckProvider(const EHiveProviderType& ProviderType, const FHiveAuthV4OnCheckProviderDelegate& Delegate);
539
576 static void CheckMaintenance(bool IsShow, const FHiveAuthV4OnMaintenanceInfoDelegate& Delegate);
577
607 static void CheckBlacklist(bool IsShow, const FHiveAuthV4OnMaintenanceInfoDelegate& Delegate);
608
638 static void SetProviderChangedListener(const FHiveAuthV4OnCheckProviderDelegate& Delegate);
639
661 static void ShowSignIn(const FHiveAuthV4OnSignInDelegate& Delegate);
662
682 static void ShowInquiry(const FHiveAuthV4OnShowInquiryDelegate& Delegate);
683
700 static void ShowChatbotInquiry(const FString& AdditionalInfo, const FHiveAuthV4OnShowInquiryDelegate& Delegate);
701
719 static void ShowMyInquiry(const FHiveAuthV4OnShowInquiryDelegate& Delegate);
720
744 static void ShowTerms(const FHiveAuthV4OnShowTermsDelegate& Delegate);
745
767 static void ShowAdultConfirm(const FHiveAuthV4OnAdultConfirmDelegate& Delegate);
768
790 static void GetProfile(const TArray<int64> PlayerIdArray, const FHiveAuthV4OnGetProfileDelegate& Delegate);
791
815 static void ShowProfile(int64 PlayerId, const FHiveAuthV4OnShowProfileDelegate& Delegate);
816
828 static void ResetAgreement();
829
863 static bool IsAutoSignIn();
864
889 static TOptional<FHivePlayerInfo> GetPlayerInfo();
890
916 static void GetProviderFriendsList(const EHiveProviderType& ProviderType, const FHiveAuthV4OnGetProviderFriendsListDelegate& Delegate);
917
946 static void ResolveConflict(const FHiveAuthV4OnResolveConflictDelegate& Delegate);
947
948 // nothing
949 static void ShowGameCenterLoginCancelDialog(const FHiveAuthV4OnAuthV4DialogDismissDelegate& Delegate);
950
969 static bool GetAgeGateU13();
970
988 static void ShowDeviceManagement(const FHiveAuthV4OnShowDeviceManagementDelegate& Delegate);
989
1000 static void GetHiveTalkPlusLoginToken(const FHiveAuthV4OnGetHiveTalkPlusLoginTokenDelegate& Delegate);
1001
1012 static void RefreshAccessToken(const FHiveAuthV4OnRefreshAccessTokenDelegate& Delegate);
1013
1041 class HIVESDK_API Helper
1042 {
1043 public:
1141 static void SyncAccount(const EHiveProviderType& ProviderType, const FHiveAuthV4HelperDelegate& Delegate);
1142
1256 static void SignIn(const FHiveAuthV4HelperDelegate& Delegate);
1257
1327 static void SignOut(const FHiveAuthV4HelperDelegate& Delegate);
1328
1398 static void PlayerDelete(const FHiveAuthV4HelperDelegate& Delegate);
1399
1500 static void Connect(const EHiveProviderType& ProviderType, const FHiveAuthV4HelperDelegate& Delegate);
1501
1582 static void Disconnect(const EHiveProviderType& ProviderType, const FHiveAuthV4HelperDelegate& Delegate);
1583
1691 static void ShowAchievements(const FHiveAuthV4HelperDelegate& Delegate);
1692
1799 static void ShowLeaderboard(const FHiveAuthV4HelperDelegate& Delegate);
1800
1881 static void AchievementsReveal(const FString& achievementId, const FHiveAuthV4HelperDelegate& Delegate);
1882
1963 static void AchievementsUnlock(const FString& achievementId, const FHiveAuthV4HelperDelegate& Delegate);
1964
2049 static void AchievementsIncrement(const FString& AchievementId, int64 value, const FHiveAuthV4HelperDelegate& Delegate);
2050
2133 static void LeaderboardsSubmitScore(const FString& LeaderboardId, int64 value, const FHiveAuthV4HelperDelegate& Delegate);
2134
2195 static void ShowConflict(const FHiveAuthV4HelperDelegate& Delegate);
2196
2260 static void ShowConflict(const FHiveConflictSingleViewData& ViewData, const FHiveAuthV4HelperDelegate& Delegate);
2261
2304 static void SwitchAccount(const FHiveAuthV4HelperDelegate& Delegate);
2305
2348 static void ResolveConflict(const FHiveAuthV4HelperDelegate& Delegate);
2349
2362 static TArray<EHiveProviderType> GetIDPList();
2363
2381 static void ShowGameCenterLoginCancelDialog(const FHiveAuthV4HelperOnDialogDismissDelegate& Delegate);
2382 };
2383};
Provides HIVE SDK initialization and HIVE authentication functions The HIVE SDK performs initializat...
Definition: HiveAuthV4.h:84
static void AchievementsReveal(const FString &achievementId, const FHiveAuthV4HelperDelegate &Delegate)
Reveal hidden achievement.
static void LeaderboardsSubmitScore(const FString &LeaderboardId, int64 value, const FHiveAuthV4HelperDelegate &Delegate)
It update the leaderboard score.
static void SyncAccount(const EHiveProviderType &ProviderType, const FHiveAuthV4HelperDelegate &Delegate)
Helps to inform whether accounts conflict or not when executing the provided as well as other APIs.
static void Connect(const EHiveProviderType &ProviderType, const FHiveAuthV4HelperDelegate &Delegate)
Provider Connection
static void ShowConflict(const FHiveConflictSingleViewData &ViewData, const FHiveAuthV4HelperDelegate &Delegate)
Displays conflict status, and HIVE UI which is available to select an account as well as shows game i...
static void PlayerDelete(const FHiveAuthV4HelperDelegate &Delegate)
사용자 삭제
static void ShowConflict(const FHiveAuthV4HelperDelegate &Delegate)
Displays conflict status, and HIVE UI avilable to select an account.
static void AchievementsIncrement(const FString &AchievementId, int64 value, const FHiveAuthV4HelperDelegate &Delegate)
Increases achievement figures.
static void SignIn(const FHiveAuthV4HelperDelegate &Delegate)
Player sign-in
static void Disconnect(const EHiveProviderType &ProviderType, const FHiveAuthV4HelperDelegate &Delegate)
Provider disconnetion
static void SignOut(const FHiveAuthV4HelperDelegate &Delegate)
Player sign-out
static void AchievementsUnlock(const FString &achievementId, const FHiveAuthV4HelperDelegate &Delegate)
Unlock achievement.
static void SwitchAccount(const FHiveAuthV4HelperDelegate &Delegate)
If accounts conflict, sign out the current player and try to sign in with the account signed in on t...
static void ShowAchievements(const FHiveAuthV4HelperDelegate &Delegate)
Queries Achievements
static TArray< EHiveProviderType > GetIDPList()
Receives the Provider lists sent by SDK.
static void ShowGameCenterLoginCancelDialog(const FHiveAuthV4HelperOnDialogDismissDelegate &Delegate)
If a sign-in window of Game Center is not displayed, show its status and display a UI to inform how ...
static void ShowLeaderboard(const FHiveAuthV4HelperDelegate &Delegate)
Queries leaderboard
static void ResolveConflict(const FHiveAuthV4HelperDelegate &Delegate)
In case it is not changed the currently signed-in account after accounts conflict.
static void SignOut(const FHiveAuthV4OnSignOutDelegate &Delegate)
it remove the local session.
static void ShowDeviceManagement(const FHiveAuthV4OnShowDeviceManagementDelegate &Delegate)
It shows the device management UI.
static void CheckMaintenance(bool IsShow, const FHiveAuthV4OnMaintenanceInfoDelegate &Delegate)
It display maintenance status and return its data.
static void CheckProvider(const EHiveProviderType &ProviderType, const FHiveAuthV4OnCheckProviderDelegate &Delegate)
It check the status of the requested Provider.
static void DisconnectWithName(const FString &ProviderName, const FHiveAuthV4OnDisconnectDelegate &Delegate)
Releases the currently signed-in user from the requested custom provider.
static TOptional< FHivePlayerInfo > GetPlayerInfo()
It returns information about the currently signed-in user.
static void ShowInquiry(const FHiveAuthV4OnShowInquiryDelegate &Delegate)
It shows the 1: 1 query UI.
static void ShowProfile(int64 PlayerId, const FHiveAuthV4OnShowProfileDelegate &Delegate)
It display the profile UI of the requested playerId.
static void ResolveConflict(const FHiveAuthV4OnResolveConflictDelegate &Delegate)
It resolve the account conflicts(CONFLICT_PLAYER) caused by connect () call.
static void ShowSignIn(const FHiveAuthV4OnSignInDelegate &Delegate)
It shows the UI with a list of providers that can sign-in.
static void ShowTerms(const FHiveAuthV4OnShowTermsDelegate &Delegate)
It shows HIVE Terms and Conditions.
static void ConnectWithAuthKey(const FString &AuthKey, const FHiveAuthV4OnConnectDelegate &Delegate)
Requests connect with authKey gained from customized provider login implementation.
static void SetProviderChangedListener(const FHiveAuthV4OnCheckProviderDelegate &Delegate)
It set a handler to be notified whether the information of the linked Provider has changed.
static void GetHiveTalkPlusLoginToken(const FHiveAuthV4OnGetHiveTalkPlusLoginTokenDelegate &Delegate)
Get the required login token when logging in to HiveTalkPlus.
static void Setup(const FHiveAuthV4OnSetupDelegate &Delegate)
AuthV4 Perform initialization.
static void PlayerDelete(const FHiveAuthV4OnSignOutDelegate &Delegate)
Delete the account and remove the local session.
static void SignIn(const EHiveProviderType &ProviderType, const FHiveAuthV4OnSignInDelegate &Delegate)
Requests signIn according to the given providerType.
EHiveProviderType
Provider Types AUTO is for Automatic Login If the result of isAutoSignIn() call is true,...
Definition: HiveAuthV4Types.h:29
static void CheckBlacklist(bool IsShow, const FHiveAuthV4OnMaintenanceInfoDelegate &Delegate)
it check the restriction status of the current user.
static void Connect(const EHiveProviderType &ProviderType, const FHiveAuthV4OnConnectDelegate &Delegate)
It connects to the currently requested provider for the currently signed-in user.
static bool IsAutoSignIn()
It returns whether signIn (AUTO) is enabled.
static void ShowMyInquiry(const FHiveAuthV4OnShowInquiryDelegate &Delegate)
It shows the 1: 1 query UI.
static void GetProfile(const TArray< int64 > PlayerIdArray, const FHiveAuthV4OnGetProfileDelegate &Delegate)
it returns the profile information of the requested playerIds.
static void SignInWithAuthKey(const FString &AuthKey, const FHiveAuthV4OnSignInDelegate &Delegate)
Requests signIn with authKey gained from customized provider login implementation.
static void RefreshAccessToken(const FHiveAuthV4OnRefreshAccessTokenDelegate &Delegate)
Get the required access token when logging in to Hive.
static void ResetAgreement()
Initialize data related to agreement to terms.
static void ShowChatbotInquiry(const FString &AdditionalInfo, const FHiveAuthV4OnShowInquiryDelegate &Delegate)
Show HIVE Chatbot 1:1 inquiry
static void SelectConflict(int64 SelectedPlayerId, const FHiveAuthV4OnSignInDelegate &Delegate)
When an account conflict (CONFLICT_PLAYER) occurs due to connect, it notify the selected user to the ...
static void ShowAdultConfirm(const FHiveAuthV4OnAdultConfirmDelegate &Delegate)
It request adult authentication.
static void ShowConflictSelection(const FHiveConflictViewData &ConflictViewData, const FHiveAuthV4OnSignInDelegate &Delegate)
It shows UI to select user in conflict state.
static void GetProviderFriendsList(const EHiveProviderType &ProviderType, const FHiveAuthV4OnGetProviderFriendsListDelegate &Delegate)
It returns the playerId list information of the friends of the connected user corresponding to the in...
static void Disconnect(const EHiveProviderType &ProviderType, const FHiveAuthV4OnDisconnectDelegate &Delegate)
Releases the currently signed-in user from the requested provider.
Copyright © Com2uS Platform Corporation. All Right Reserved. Terms of Use Privacy Policy