Provides advanced features of HIVE Authentication. More...

Functions
static void	FHiveAuthV4::Helper::SyncAccount (const EHiveProviderType &ProviderType, const FHiveAuthV4HelperDelegate &Delegate)
	Helps to inform whether accounts conflict or not when executing the provided as well as other APIs. More...

static void	FHiveAuthV4::Helper::SignIn (const FHiveAuthV4HelperDelegate &Delegate)
	Player sign-in More...

static void	FHiveAuthV4::Helper::SignOut (const FHiveAuthV4HelperDelegate &Delegate)
	Player sign-out More...

static void	FHiveAuthV4::Helper::PlayerDelete (const FHiveAuthV4HelperDelegate &Delegate)
	사용자 삭제 More...

static void	FHiveAuthV4::Helper::Connect (const EHiveProviderType &ProviderType, const FHiveAuthV4HelperDelegate &Delegate)
	Provider Connection More...

static void	FHiveAuthV4::Helper::Disconnect (const EHiveProviderType &ProviderType, const FHiveAuthV4HelperDelegate &Delegate)
	Provider disconnetion More...

static void	FHiveAuthV4::Helper::ShowAchievements (const FHiveAuthV4HelperDelegate &Delegate)
	Queries Achievements More...

static void	FHiveAuthV4::Helper::ShowLeaderboard (const FHiveAuthV4HelperDelegate &Delegate)
	Queries leaderboard More...

static void	FHiveAuthV4::Helper::AchievementsReveal (const FString &achievementId, const FHiveAuthV4HelperDelegate &Delegate)
	Reveal hidden achievement. More...

static void	FHiveAuthV4::Helper::AchievementsUnlock (const FString &achievementId, const FHiveAuthV4HelperDelegate &Delegate)
	Unlock achievement. More...

static void	FHiveAuthV4::Helper::AchievementsIncrement (const FString &AchievementId, int64 value, const FHiveAuthV4HelperDelegate &Delegate)
	Increases achievement figures. More...

static void	FHiveAuthV4::Helper::LeaderboardsSubmitScore (const FString &LeaderboardId, int64 value, const FHiveAuthV4HelperDelegate &Delegate)
	It update the leaderboard score. More...

static void	FHiveAuthV4::Helper::ShowConflict (const FHiveAuthV4HelperDelegate &Delegate)
	Displays conflict status, and HIVE UI avilable to select an account. More...

static void	FHiveAuthV4::Helper::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 information. More...

static void	FHiveAuthV4::Helper::SwitchAccount (const FHiveAuthV4HelperDelegate &Delegate)
	If accounts conflict, sign out the current player and try to sign in with the account signed in on the user device. More...

static void	FHiveAuthV4::Helper::ResolveConflict (const FHiveAuthV4HelperDelegate &Delegate)
	In case it is not changed the currently signed-in account after accounts conflict. More...

static TArray< EHiveProviderType >	FHiveAuthV4::Helper::GetIDPList ()
	Receives the Provider lists sent by SDK. More...

static void	FHiveAuthV4::Helper::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 to sign in the Game Center. More...

Detailed Description

Provides advanced features of HIVE Authentication.

The detailed functions provided by this class are as follows.

Sign-in/Sign-out
Connect/Disconnect Providers
Query Achievement/Leaderboard
Query/Resolve account conflicts state

Function Documentation

◆ AchievementsIncrement()

static void FHiveAuthV4::Helper::AchievementsIncrement	(	const FString &	AchievementId,
		int64	value,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Increases achievement figures.

Achievement figures is added as much as value set by the API call, not by setting.
If the total sum is Max, the achievement is automatically accomplished.

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Reference

It tries to execute the service automatically if the signed-in account is diconnected with PGS/GameCenter.

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to request achievementsIncrement	-
RESPONSE_FAIL	AuthV4GoogleResponseFailAchievementsIncrement	Failed to request achievementsIncrement	-

Parameters

AchievementId	achievements's key value
value	value
Delegate	FHiveAuthV4HelperDelegate achievementsIncrement result callback

◆ AchievementsReveal()

static void FHiveAuthV4::Helper::AchievementsReveal	(	const FString &	achievementId,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Reveal hidden achievement.

Achievements are only revealed at 0%, not achieved.

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Reference

It tries to execute the service automatically if the signed-in account is diconnected with PGS/GameCenter.

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to request achievementsReveal	-
RESPONSE_FAIL	AuthV4GoogleResponseFailAchievementsReveal	Failed to request achievementsReveal	-

Parameters

achievementId	achievements's key value
Delegate	FHiveAuthV4HelperDelegate achievementsReveal result callback

◆ AchievementsUnlock()

static void FHiveAuthV4::Helper::AchievementsUnlock	(	const FString &	achievementId,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Unlock achievement.

Whether hidden or open, achievement is achieved at 100%.

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Reference

It tries to execute the service automatically if the signed-in account is diconnected with PGS/GameCenter.

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to request achievementsUnlock	-
RESPONSE_FAIL	AuthV4GoogleResponseFailAchievementsUnlock	Failed to request achievementsUnlock	-

Parameters

achievementId	achievements's key value
Delegate	FHiveAuthV4HelperDelegate achievementsUnlock result callback

◆ Connect()

static void FHiveAuthV4::Helper::Connect	(	const EHiveProviderType &	ProviderType,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Provider Connection

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to conenct with Provider	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
CANCELED	AuthV4AppleLoginCancel	If a sign-in window of Game Center is not displayed or the sign-in on Game Center is cancelled,	use AuthV4.helper.showGameCenterLoginCancelDialog() API or implement directly to inform how to sign in the Game Center
CONFLICT_PLAYER	AuthV4ConflictPlayer	the player ID of the Provider to be connected already existed playerInfo: The information of conflicted account	Follow the resolution in accordance with the type of account conflicts

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Connect result callback

◆ Disconnect()

static void FHiveAuthV4::Helper::Disconnect	(	const EHiveProviderType &	ProviderType,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Provider disconnetion

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to discconect with Provider	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
INVALID_PARAM	AuthV4ProviderAlreadtDisconnected	The Provider requested to disconnect was not connected with the account	-

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Disconnect result callback

◆ GetIDPList()

static TArray< EHiveProviderType > FHiveAuthV4::Helper::GetIDPList ( )

static

Receives the Provider lists sent by SDK.

◆ LeaderboardsSubmitScore()

static void FHiveAuthV4::Helper::LeaderboardsSubmitScore	(	const FString &	LeaderboardId,
		int64	value,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

It update the leaderboard score.

The score corresponding to the leaderboardId is updated with the score value.

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Reference

It tries to execute the service automatically if the signed-in account is diconnected with PGS/GameCenter.

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to request LeaderboardsSubmitScore	-
RESPONSE_FAIL	AuthV4GoogleResponseFailLeaderboardsSubmitScore	Failed to request LeaderboardsSubmitScore	-

Parameters

LeaderboardId	leaderboard's key value
value	Leaderboard score
Delegate	FHiveAuthV4HelperDelegate LeaderboardsSubmitScore result callback

◆ PlayerDelete()

static void FHiveAuthV4::Helper::PlayerDelete ( const FHiveAuthV4HelperDelegate & Delegate )

static

사용자 삭제

\~korean

사용 조건

HIVE SDK 초기화
HIVE SignIn 완료

주요 결과 코드

ErrorCode	Code	Description	Solution
SUCCESS	Success	로그아웃 성공	-
NEED_INITIALIZED	AuthV4NotInitialized	HIVE SDK가 초기화되지 않은 경우	AuthV4.setup() API로 HIVE SDK 초기화

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper PlayerDelete 결과 통지

Player delete

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to sign out	-
NEED_INITIALIZED	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper PlayerDelete result callback

◆ ResolveConflict()

static void FHiveAuthV4::Helper::ResolveConflict ( const FHiveAuthV4HelperDelegate & Delegate )

static

In case it is not changed the currently signed-in account after accounts conflict.

Key result code

ErrorCode	Code	Description
CANCELED	AuthV4PlayerResolved	Not changed the currently signed-in account after accounts conflict

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Resolve Conflict result callback

◆ ShowAchievements()

static void FHiveAuthV4::Helper::ShowAchievements ( const FHiveAuthV4HelperDelegate & Delegate )

static

Queries Achievements

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Reference

It tries to execute the service automatically if the signed-in account is diconnected with PGS/GameCenter.

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to request Acheivement	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
CANCELED	AuthV4AppleLoginCancel	If a sign-in window of Game Center is not displayed or the sign-in on Game Center is cancelled,	use AuthV4.helper.showGameCenterLoginCancelDialog() API or implement directly to inform how to sign in the Game Center
CONFLICT_PLAYER	AuthV4ConflictPlayer	The account signed in on user device is mismatched with the PGS/Game Center account on the game or the player ID of the Provider to be connected already existed	Follow the resolution in accordance with the type of account conflicts

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Show achievements result callback

◆ ShowConflict() [1/2]

static void FHiveAuthV4::Helper::ShowConflict ( const FHiveAuthV4HelperDelegate & Delegate )

static

Displays conflict status, and HIVE UI avilable to select an account.

Key result code

ErrorCode	Code	Description
PLAYER_CHANGE	AuthV4PlayerChange	Succeeded to change the player after accounts conflict
CANCELED	AuthV4PlayerResolved	Not changed the currently signed-in account after accounts conflict
INVALID_PARAM	AuthV4InvalidConflictInfo	Requested to resolve account conflicts not happened

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Show Conflict result callback

◆ ShowConflict() [2/2]

static void FHiveAuthV4::Helper::ShowConflict	(	const FHiveConflictSingleViewData &	ViewData,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Displays conflict status, and HIVE UI which is available to select an account as well as shows game information.

Key result code

ErrorCode	Code	Description
PLAYER_CHANGE	AuthV4PlayerChange	Succeeded to change the player after accounts conflict
CANCELED	AuthV4PlayerResolved	Not changed the currently signed-in account after accounts conflict
INVALID_PARAM	AuthV4InvalidConflictInfo	Requested to resolve account conflicts not happened

Parameters

ViewData	ConflictSingleViewInfo Game information of the account-conflicted player
Delegate	FHiveAuthV4HelperDelegate AuthV4Helper Show Conflict result callback

◆ ShowGameCenterLoginCancelDialog()

static void FHiveAuthV4::Helper::ShowGameCenterLoginCancelDialog ( const FHiveAuthV4HelperOnDialogDismissDelegate & Delegate )

static

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.

Parameters

Delegate FHiveAuthV4HelperOnDialogDismissDelegate callback whether account notification popup is closed or not

◆ ShowLeaderboard()

static void FHiveAuthV4::Helper::ShowLeaderboard ( const FHiveAuthV4HelperDelegate & Delegate )

static

Queries leaderboard

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Refernce

It tries to execute the service automatically if the signed-in account is diconnected with PGS/GameCenter.

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to request leaderboards	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
CANCELED	AuthV4AppleLoginCancel	If a sign-in window of Game Center is not displayed or the sign-in on Game Center is cancelled,	use AuthV4.helper.showGameCenterLoginCancelDialog() API or implement directly to inform how to sign in the Game Center
CONFLICT_PLAYER	AuthV4ConflictPlayer	The account signed in on user device is mismatched with the PGS/Game Center account on the game or the player ID of the Provider to be connected already existed	Follow the resolution in accordance with the type of account conflicts

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Show leaderboard result callback

◆ SignIn()

static void FHiveAuthV4::Helper::SignIn ( const FHiveAuthV4HelperDelegate & Delegate )

static

Player sign-in

Condition of use

Complete to initialize HIVE SDK

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to sign in playerInfo: The information of signed-in player	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
IN_PROGRESS	AuthV4InProgressSignIn	Requested to process SignIn while sign-in is in progress	Wait for the SignIn request in progress
CONFLICT_PLAYER	AuthV4ConflictPlayer	The account signed in on user device is mismatched with the PGS/Game Center account on the game or the player ID of the Provider to be connected already existed playerInfo: The information of conflicted account	Follow the resolution in accordance with the type of account conflicts
INVALID_SESSION	AuthV4HelperImplifiedLoginFail	Required Explicit Login due to failure of Implicit Login	Query the supported Provider lists by calling AuthV4.Helper.getIDPList() and implement Explicit Login UI, or implement Explicit Login by calling AuthV4.showSignIn() of HIVE UI

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Sign In result callback

◆ SignOut()

static void FHiveAuthV4::Helper::SignOut ( const FHiveAuthV4HelperDelegate & Delegate )

static

Player sign-out

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to sign out	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Sign Out result callback

◆ SwitchAccount()

static void FHiveAuthV4::Helper::SwitchAccount ( const FHiveAuthV4HelperDelegate & Delegate )

static

If accounts conflict, sign out the current player
and try to sign in with the account signed in on the user device.

Key result code

ErrorCode	Code	Description
PLAYER_CHANGE	AuthV4PlayerChange	Succeeded to change the player after accounts conflict

Parameters

Delegate FHiveAuthV4HelperDelegate AuthV4Helper Switch Account result callback

◆ SyncAccount()

static void FHiveAuthV4::Helper::SyncAccount	(	const EHiveProviderType &	ProviderType,
		const FHiveAuthV4HelperDelegate &	Delegate
	)

static

Helps to inform whether accounts conflict or not when executing the provided as well as other APIs.

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Account normal state	-
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
CONFLICT_PLAYER	AuthV4ConflictPlayer	Mismatched the signed-in account with PGS/GameCenter account on the device	Follow the resolution in accordance with the type of account conflicts
NOT_SUPPORTED	AuthV4NotSupportedProviderType	Queried account state with other provider types except PGS/GameCenter	-

Parameters

providerType	ProviderType to request syncronization
listener	onAuthV4Helper AuthV4Helper Sync Account result callback

HIVE SDK for Unreal Engine

Functions

Detailed Description

Function Documentation

◆ AchievementsIncrement()

Condition of use

Reference

Key result code

◆ AchievementsReveal()

Condition of use

Reference

Key result code

◆ AchievementsUnlock()

Condition of use

Reference

Key result code

◆ Connect()

Condition of use

Key result code

◆ Disconnect()

Condition of use

Key result code

◆ GetIDPList()

◆ LeaderboardsSubmitScore()

Condition of use

Reference

Key result code

◆ PlayerDelete()

사용 조건

주요 결과 코드

Condition of use

Key result code

◆ ResolveConflict()

Key result code

◆ ShowAchievements()

Condition of use

Reference

Key result code

◆ ShowConflict() [1/2]

Key result code

◆ ShowConflict() [2/2]

Key result code

◆ ShowGameCenterLoginCancelDialog()

◆ ShowLeaderboard()

Condition of use

Refernce

Key result code

◆ SignIn()

Condition of use

Key result code

◆ SignOut()

Condition of use

Key result code

◆ SwitchAccount()

Key result code

◆ SyncAccount()

Condition of use

Key result code