Provides advanced features of HIVE Authentication. More...

Typedefs
typedef std::function< void(ResultAPI const &result, std::shared_ptr< PlayerInfo > playerInfo)>	AuthV4::Helper::onAuthV4Helper
	AuthV4Helper API request result callback. More...

Functions
static void	AuthV4::Helper::syncAccount (ProviderType providerType, onAuthV4Helper listener)
	Helps to inform whether accounts conflict or not when executing the provided as well as other APIs. More...

static void	AuthV4::Helper::signIn (onAuthV4Helper listener)
	Player sign-in More...

static void	AuthV4::Helper::signOut (onAuthV4Helper listener)
	Player sign-out More...

static void	AuthV4::Helper::playerDelete (onAuthV4Helper listener)
	사용자 삭제 More...

static void	AuthV4::Helper::connect (ProviderType providerType, onAuthV4Helper listener)
	Provider Connection More...

static void	AuthV4::Helper::disconnect (ProviderType providerType, onAuthV4Helper listener)
	Provider disconnetion More...

static void	AuthV4::Helper::showAchievements (onAuthV4Helper listener)
	Queries Achievements More...

static void	AuthV4::Helper::showLeaderboard (onAuthV4Helper listener)
	Queries leaderboard More...

static void	AuthV4::Helper::achievementsReveal (const std::string achievementId, onAuthV4Helper listener)
	Reveal hidden achievement. More...

static void	AuthV4::Helper::achievementsUnlock (const std::string achievementId, onAuthV4Helper listener)
	Unlock achievement. More...

static void	AuthV4::Helper::achievementsIncrement (const std::string achievementId, const int value, onAuthV4Helper listener)
	Increases achievement figures. More...

static void	AuthV4::Helper::leaderboardsSubmitScore (const std::string leaderboardId, const long long score, onAuthV4Helper listener)
	It update the leaderboard score. More...

static void	AuthV4::Helper::showConflict (onAuthV4Helper listener)
	Displays conflict status, and HIVE UI avilable to select an account. More...

static void	AuthV4::Helper::showConflict (ConflictSingleViewInfo const &viewInfo, onAuthV4Helper listener)
	Displays conflict status, and HIVE UI which is available to select an account as well as shows game information. More...

static void	AuthV4::Helper::switchAccount (onAuthV4Helper listener)
	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	AuthV4::Helper::resolveConflict (onAuthV4Helper listener)
	In case it is not changed the currently signed-in account after accounts conflict. More...

static std::vector< ProviderType >	AuthV4::Helper::getIDPList ()
	Receives the Provider lists sent by SDK. More...

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

	ConflictSingleViewInfo::ConflictSingleViewInfo (hive::PlayerID playerId)
	생성자 More...

	ConflictViewInfo::ConflictViewInfo (hive::PlayerID currentPlayerId, hive::PlayerID conflictPlayerId)
	생성자 More...

static std::string	ProviderInfo::stringProviderType (hive::ProviderType providerType)
	Provider type으로 string 값을 얻어온다. More...

static hive::ProviderType	ProviderInfo::providerTypeFromString (const std::string typeString)
	Provider string값으로 type을 얻어온다. More...

Variables
hive::PlayerID	ProfileInfo::playerId
	사용자 Player ID

std::string	PlayerInfo::playerToken
	사용자 Player 세션 토큰.

std::string	PlayerInfo::accessToken
	사용자 Hive 세션 토큰.

std::string	PlayerInfo::did
	사용자 device identifier.

std::string	ParentalConsentInfo::dateOfBirth
	유저의 생년월일

std::string	ParentalConsentInfo::guardianEmail
	보호자 이메일 주소

hive::ProviderType	ProviderInfo::providerType
	Provider의 type.

std::string	ProviderInfo::providerUserId
	< Provider의 이름. More...

std::string	ProviderInfo::providerEmail
	Provider의 사용자 email (optional)

std::string	AuthV4MaintenanceExtraButton::button
	Text on the button.

hive::AuthV4MaintenanceActionType	AuthV4MaintenanceExtraButton::action
	Actions to be taken when the button is pressed.

std::string	AuthV4MaintenanceExtraButton::url
	URL to be browsed when action is OPEN_URL.

std::string	AuthV4MaintenanceInfo::title
	Title.

std::string	AuthV4MaintenanceInfo::message
	Contents.

std::string	AuthV4MaintenanceInfo::button
	Text on the button ex) OK.

hive::AuthV4MaintenanceActionType	AuthV4MaintenanceInfo::action
	Actions to be taken when the button is pressed.

std::string	AuthV4MaintenanceInfo::url
	URL to be browsed when action is OPEN_URL.

std::string	AuthV4MaintenanceInfo::startDate
	start time YYYY-mm-dd HH:ii

std::string	AuthV4MaintenanceInfo::endDate
	end time YYYY-mm-dd HH:ii

int	AuthV4MaintenanceInfo::remainingTime
	When action is EXIT, the time in seconds remaining until the maintenance completes. The time is updated in real time, and the app will be closed at 0 seconds.

std::string	AuthV4MaintenanceInfo::customerLink
	customer Title

std::vector< AuthV4MaintenanceExtraButton >	AuthV4MaintenanceInfo::exButtons
	customer Link

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

Typedef Documentation

◆ onAuthV4Helper

typedef std::function<void(ResultAPI const & result,std::shared_ptr<PlayerInfo> playerInfo)> AuthV4::Helper::onAuthV4Helper

AuthV4Helper API request result callback.

Parameters

result

ErrorCodes and Codes available for result values are as follows.

ErrorCode	Code	Description
SUCCESS	Success	Completed the request without account conflicts
NEED_INITIALIZE	AuthV4NotInitialized	Not initialized the HIVE SDK
INVALID_SESSION	AuthV4SigninFirst	Called the APIs required sign-in before sign-in
INVALID_PARAM	AuthV4AlreadyAuthorized	Called sign-in API again after sign-in
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
PLAYER_CHANGE	AuthV4PlayerChange	Succeeded to change the player after accounts conflict
CANCELED	AuthV4PlayerResolved	Not changed the currently signed-in account after accounts conflict
INVALID_SESSION	AuthV4HelperImplifiedLoginFail	Required Explicit Login due to failure of Implicit Login
IN_PROGRESS	AuthV4InProgressSignIn AuthV4InProgressConnect AuthV4InProgressShowLeaderboard AuthV4InProgressShowAchievements	The request is still in progress

playerInfo

Player information depending on results are as follows.

ErrorCode	Code	Player Info
SUCCESS	Success	The information of signed-in player
CONFLICT_PLAYER	AuthV4ConflictPlayer	The information of conflicted player
PLAYER_CHANGE	AuthV4PlayerChange	The information of the player who successfully changed its account
CANCELED	AuthV4PlayerResolved	The information of current player

See also: HIVEResultAPI, HIVEPlayerInfo

Function Documentation

◆ achievementsIncrement()

static void AuthV4::Helper::achievementsIncrement	(	const std::string	achievementId,
		const int	value,
		onAuthV4Helper	listener
	)

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

incrementalAchievementId	achievements's key value
value	value
listener	onAuthV4Helper achievementsIncrement result callback

◆ achievementsReveal()

static void AuthV4::Helper::achievementsReveal	(	const std::string	achievementId,
		onAuthV4Helper	listener
	)

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
listener	onAuthV4Helper achievementsReveal result callback

◆ achievementsUnlock()

static void AuthV4::Helper::achievementsUnlock	(	const std::string	achievementId,
		onAuthV4Helper	listener
	)

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
listener	onAuthV4Helper achievementsUnlock result callback

◆ ConflictSingleViewInfo()

ConflictSingleViewInfo::ConflictSingleViewInfo ( hive::PlayerID playerId )

생성자

Parameters

playerId 충돌된 사용자의 플레이어 아이디

◆ ConflictViewInfo()

ConflictViewInfo::ConflictViewInfo	(	hive::PlayerID	currentPlayerId,
		hive::PlayerID	conflictPlayerId
	)

생성자

Parameters

currentPlayerId	현재 사용자의 플레이어 아이디
conflictPlayerId	충돌된 사용자의 플레이어 아이디

◆ connect()

static void AuthV4::Helper::connect	(	ProviderType	providerType,
		onAuthV4Helper	listener
	)

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

listener onAuthV4Helper AuthV4Helper Connect result callback

◆ disconnect()

static void AuthV4::Helper::disconnect	(	ProviderType	providerType,
		onAuthV4Helper	listener
	)

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

listener onAuthV4Helper AuthV4Helper Disconnect result callback

◆ getIDPList()

static std::vector< ProviderType > AuthV4::Helper::getIDPList ( )

static

Receives the Provider lists sent by SDK.

◆ leaderboardsSubmitScore()

static void AuthV4::Helper::leaderboardsSubmitScore	(	const std::string	leaderboardId,
		const long long	score,
		onAuthV4Helper	listener
	)

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
score	Leaderboard score
listener	onAuthV4Helper LeaderboardsSubmitScore result callback

◆ playerDelete()

static void AuthV4::Helper::playerDelete ( onAuthV4Helper listener )

static

사용자 삭제

\~korean

사용 조건

HIVE SDK 초기화
HIVE SignIn 완료

주요 결과 코드

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

Parameters

listener AuthV4HelperListener 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

listener AuthV4HelperListener AuthV4Helper PlayerDelete result callback

◆ providerTypeFromString()

static hive::ProviderType ProviderInfo::providerTypeFromString ( const std::string typeString )

static

Provider string값으로 type을 얻어온다.

Parameters

typeString Provider string.

Returns: Provider type. (ex. kHIVEProviderTypeHIVE)

◆ resolveConflict()

static void AuthV4::Helper::resolveConflict ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Resolve Conflict result callback

◆ showAchievements()

static void AuthV4::Helper::showAchievements ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Show achievements result callback

◆ showConflict() [1/2]

static void AuthV4::Helper::showConflict	(	ConflictSingleViewInfo const &	viewInfo,
		onAuthV4Helper	listener
	)

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

conflictData	ConflictSingleViewInfo Game information of the account-conflicted player
listener	onAuthV4Helper AuthV4Helper Show Conflict result callback

See also: HIVEConflictSingleViewInfo

◆ showConflict() [2/2]

static void AuthV4::Helper::showConflict ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Show Conflict result callback

◆ showGameCenterLoginCancelDialog()

static void AuthV4::Helper::showGameCenterLoginCancelDialog ( onAuthV4DialogDismiss listener )

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

listener onAuthV4DialogDismiss callback whether account notification popup is closed or not

See also: onAuthV4DialogDismiss

◆ showLeaderboard()

static void AuthV4::Helper::showLeaderboard ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Show leaderboard result callback

◆ signIn()

static void AuthV4::Helper::signIn ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Sign In result callback

◆ signOut()

static void AuthV4::Helper::signOut ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Sign Out result callback

◆ stringProviderType()

static std::string ProviderInfo::stringProviderType ( hive::ProviderType providerType )

static

Provider type으로 string 값을 얻어온다.

Parameters

providerType Provider Type.

Returns: Provier string. (ex. HIVE)

◆ switchAccount()

static void AuthV4::Helper::switchAccount ( onAuthV4Helper listener )

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

listener onAuthV4Helper AuthV4Helper Switch Account result callback

◆ syncAccount()

static void AuthV4::Helper::syncAccount	(	ProviderType	providerType,
		onAuthV4Helper	listener
	)

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

Variable Documentation

◆ providerUserId

std::string ProviderInfo::providerUserId

< Provider의 이름.

Provider의 사용자 user identifier.

HIVE SDK for C++

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ onAuthV4Helper

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

◆ ConflictSingleViewInfo()

◆ ConflictViewInfo()

◆ 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

◆ providerTypeFromString()

◆ 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

◆ stringProviderType()

◆ switchAccount()

Key result code

◆ syncAccount()

Condition of use

Key result code

Variable Documentation

◆ providerUserId