Classes
class	hive.AuthV4.Helper.ConflictSingleViewInfo
	The class showing the conflicted account's game data when user accounts conflict More...

Functions
static void	hive.AuthV4.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.

delegate void	hive.AuthV4.Helper.onAuthV4Helper (ResultAPI result, PlayerInfo playerInfo)
	AuthV4Helper API request result callback.

delegate void	hive.AuthV4.Helper.onAuthV4DialogDismiss (bool isDismiss)
	AuthV4 Result callback after Game Center login pops up

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

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

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

static void	hive.AuthV4.Helper.playerDelete (onAuthV4Helper listener)
	Player delete

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

static void	hive.AuthV4.Helper.disconnect (ProviderType providerType, onAuthV4Helper listener)
	Connects Provider

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

static void	hive.AuthV4.Helper.showAchievements (onAuthV4Helper listener)
	Queries Acheivements

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

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

static void	hive.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.

static void	hive.AuthV4.Helper.resolveConflict (onAuthV4Helper listener)
	In case it is not changed the currently signed-in account after accounts conflict.

static List< ProviderType >	hive.AuthV4.Helper.getIDPList ()
	Receives the Provider lists sent by SDK.

static void	hive.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.

static void	hive.AuthV4.Helper.leaderboardsSubmitScore (String leaderboardId, long score)
	It update the leaderboard score.

static void	hive.AuthV4.Helper.leaderboardsSubmitScore (String leaderboardId, long score, onAuthV4Helper listener)
	It update the leaderboard score.

static void	hive.AuthV4.Helper.achievementsReveal (String achievementId)
	Reveal hidden achievement.

static void	hive.AuthV4.Helper.achievementsReveal (String achievementId, onAuthV4Helper listener)
	Reveal hidden achievement.

static void	hive.AuthV4.Helper.achievementsUnlock (String achievementId)
	Unlock achievement.

static void	hive.AuthV4.Helper.achievementsUnlock (String achievementId, onAuthV4Helper listener)
	Unlock achievement.

static void	hive.AuthV4.Helper.achievementsIncrement (String achievementId, int value)
	Increases achievement figures.

static void	hive.AuthV4.Helper.achievementsIncrement (String incrementalAchievementId, int value, onAuthV4Helper listener)
	Increases achievement figures.

Variables
String	hive.AuthV4.AuthV4MaintenanceInfo.title
	Title.

String	hive.AuthV4.AuthV4MaintenanceInfo.message
	Contents.

String	hive.AuthV4.AuthV4MaintenanceInfo.button
	Text on the button ex) OK.

AuthV4MaintenanceActionType	hive.AuthV4.AuthV4MaintenanceInfo.action
	Actions to be taken when the button is tapped.

String	hive.AuthV4.AuthV4MaintenanceInfo.url
	URL to be browsed when action is OPEN_URL.

int	hive.AuthV4.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.

String	hive.AuthV4.AuthV4MaintenanceInfo.startDate
	Maintenance start time YYYY-mm-dd HH:ii.

String	hive.AuthV4.AuthV4MaintenanceInfo.endDate
	Maintenance end time YYYY-mm-dd HH:ii.

String	hive.AuthV4.AuthV4MaintenanceInfo.customerButton
	Customer Service Text on the button.

String	hive.AuthV4.AuthV4MaintenanceInfo.customerLink
	The URL to go to when the Customer Service button is clicked.

List< AuthV4MaintenanceExtraButton >	hive.AuthV4.AuthV4MaintenanceInfo.exButtons = new List<AuthV4MaintenanceExtraButton>()
	Button information to configure when customizing the maintenance popup.

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() [1/2]

static void hive.AuthV4.Helper.achievementsIncrement	(	String	achievementId,
		int	value )

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.

Parameters

achievementId	achievements's key value
value	value

◆ achievementsIncrement() [2/2]

static void hive.AuthV4.Helper.achievementsIncrement	(	String	incrementalAchievementId,
		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() [1/2]

static void hive.AuthV4.Helper.achievementsReveal ( String achievementId )

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.

Parameters

achievementId achievements's key value

◆ achievementsReveal() [2/2]

static void hive.AuthV4.Helper.achievementsReveal	(	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() [1/2]

static void hive.AuthV4.Helper.achievementsUnlock ( String achievementId )

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.

Parameters

achievementId achievements's key value

◆ achievementsUnlock() [2/2]

static void hive.AuthV4.Helper.achievementsUnlock	(	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

◆ connect()

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

static

Provider Connection

Condition of use

Compelte to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Succeeded to connect with Provider	-
NEED_INITIALIZED	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
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 AuthV4HelperListener AuthV4Helper Connect result callback

◆ disconnect()

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

static

Connects Provider

Condition of use

Complete to initialize HIVE SDK
Complete HIVE SignIn

Key result code

ErrorCode	Code	Description	Solution
SUCCESS	Success	Completed to disconnect with Provider	-
NEED_INITIALIZED	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 AuthV4HelperListener AuthV4Helper Disconnect result callback

◆ getIDPList()

static List< ProviderType > hive.AuthV4.Helper.getIDPList ( )

static

Receives the Provider lists sent by SDK.

◆ leaderboardsSubmitScore() [1/2]

static void hive.AuthV4.Helper.leaderboardsSubmitScore	(	String	leaderboardId,
		long	score )

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.

Parameters

leaderboardId	leaderboard's key value
score	Leaderboard score

◆ leaderboardsSubmitScore() [2/2]

static void hive.AuthV4.Helper.leaderboardsSubmitScore	(	String	leaderboardId,
		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

◆ onAuthV4DialogDismiss()

delegate void hive.AuthV4.Helper.onAuthV4DialogDismiss ( bool isDismiss )

AuthV4 Result callback after Game Center login pops up

Parameters

isDismiss : Returns true if the popup is successfully closed.

◆ onAuthV4Helper()

delegate void hive.AuthV4.Helper.onAuthV4Helper	(	ResultAPI	result,
		PlayerInfo	playerInfo )

AuthV4Helper API request result callback.

Parameters

result

ErrorCodes and Codes available for result values are as follows.

ErrorCode	Code	Description
SUCCESS	Success	Complted the request without account conflicts
NEED_INITIALIZE	AuthV4NotInitialized	HIVE SDK not initialized
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: ResultAPI, PlayerInfo

<>

◆ playerDelete()

static void hive.AuthV4.Helper.playerDelete ( onAuthV4Helper listener )

static

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 Delete result callback

◆ resolveConflict()

static void hive.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 AuthV4HelperListener AuthV4Helper Resolve Conflict result callback

◆ showAchievements()

static void hive.AuthV4.Helper.showAchievements ( onAuthV4Helper listener )

static

Queries Acheivements

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_INITIALIZED	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
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 AuthV4HelperListener AuthV4Helper Show achievements result callback

◆ showConflict() [1/2]

static void hive.AuthV4.Helper.showConflict	(	ConflictSingleViewInfo	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
INVALID_PARAM	AuthV4InvalidConflictInfo	Requested to resolve account conflicts not happened

Parameters

conflictData	HIVEConflictSingleViewInfo Game information of the account-conflicted player
listener	AuthV4HelperListener AuthV4Helper Show Conflict result callback

See also: ConflictSingleViewInfo

◆ showConflict() [2/2]

static void hive.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
INVALID_PARAM	AuthV4InvalidConflictInfo	Requested to resolve account conflicts not happened

Parameters

listener AuthV4HelperListener AuthV4Helper Show Conflict result callback

◆ showLeaderboard()

static void hive.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_INITIALIZED	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API
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 AuthV4HelperListener AuthV4Helper Show leaderboard result callback

◆ signIn()

static void hive.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_INITIALIZED	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 AuthV4HelperListener AuthV4Helper Sign In result callback

◆ signOut()

static void hive.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_INITIALIZED	AuthV4NotInitialized	HIVE SDK not initialized	Initialize HIVE SDK by implementing AuthV4.setup() API

Parameters

listener AuthV4HelperListener AuthV4Helper Sign Out result callback

◆ switchAccount()

static void hive.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 AuthV4HelperListener AuthV4Helper Switch Account result callback

◆ syncAccount()

static void hive.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_INITIALIZED	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	AuthV4HelperListener AuthV4Helper Sync Account result callback

HIVE SDK for Unity3D

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ achievementsIncrement() [1/2]

Condition of use

Reference

◆ achievementsIncrement() [2/2]

Condition of use

Reference

Key result code

◆ achievementsReveal() [1/2]

Condition of use

Reference

◆ achievementsReveal() [2/2]

Condition of use

Reference

Key result code

◆ achievementsUnlock() [1/2]

Condition of use

Reference

◆ achievementsUnlock() [2/2]

Condition of use

Reference

Key result code

◆ connect()

Condition of use

Key result code

◆ disconnect()

Condition of use

Key result code

◆ getIDPList()

◆ leaderboardsSubmitScore() [1/2]

Condition of use

Reference

◆ leaderboardsSubmitScore() [2/2]

Condition of use

Reference

Key result code

◆ onAuthV4DialogDismiss()

◆ onAuthV4Helper()

◆ 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

◆ 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