Provides HIVE SDK initialization and HIVE authentication functions
The HIVE SDK performs initialization based on the xml configuration file. More...

Classes
enum	com.hive.AuthV4.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	com.hive.AuthV4.AuthV4MaintenanceActionType
	Actions to be taken when a button is pressed on the maintenance popup. More...

class	com.hive.AuthV4.ProfileInfo
	User Profile Information playerID : User's unique ID playerName : The nickname of the user to be shown outside. More...

class	com.hive.AuthV4.PlayerInfo
	Sign-in User Information it includes user's tocken and DID value along with ProfileInfo. More...

class	com.hive.AuthV4.ProviderInfo
	Identity Provider (IdP) Information It contains the UserId of the associated Identity Provider. More...

class	com.hive.AuthV4.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	com.hive.AuthV4
	Provides HIVE SDK initialization and HIVE authentication functions The HIVE SDK performs initialization based on the xml configuration file. More...

Functions
void	com.hive.AuthV4.AuthV4SetupListener.onAuthV4Setup (ResultAPI result, boolean isAutoSignIn, String did, ArrayList< ProviderType > providerTypeList)
	AuthV4 initialization result callback result : When initial initialize is executed, it fails if it does not receive DID or Provider List. More...

void	com.hive.AuthV4.AuthV4SignInListener.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...

void	com.hive.AuthV4.AuthV4SignOutListener.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. 그 외 성공 More...

void	com.hive.AuthV4.AuthV4ConnectListener.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...

void	com.hive.AuthV4.AuthV4DisconnectListener.onAuthV4Disconnect (ResultAPI result)
	AuthV4 Provider disconnect result callback It pass the disconnect status to the authentication server and then logout the requested provider. More...

void	com.hive.AuthV4.AuthV4GetProfileListener.onAuthV4GetProfile (ResultAPI result, ArrayList< ProfileInfo > profileInfoList)
	AuthV4 Profile information request result callback The profile information of the playerIds which are requested to the profile server is returned. More...

void	com.hive.AuthV4.AuthV4ShowProfileListener.onAuthV4ShowProfile (ResultAPI result)
	AuthV4 Profile UI request result callback Invoked when the UI window is closed. More...

void	com.hive.AuthV4.AuthV4ShowCafeListener.onAuthV4ShowCafe (ResultAPI result)
	AuthV4 Cafe UI request result callback Invoked when the UI window is closed. More...

void	com.hive.AuthV4.AuthV4ShowInquiryListener.onAuthV4ShowInquiry (ResultAPI result)
	AuthV4 1:1 Inquiry UI request result callback Invoked when the UI window is closed. More...

void	com.hive.AuthV4.AuthV4ShowTermsListener.onAuthV4ShowTerms (ResultAPI result)
	AuthV4 Terms of Service UI request result callback Invoked when the UI window is closed. More...

void	com.hive.AuthV4.AuthV4AdultConfirmListener.onAuthV4AdultConfirm (ResultAPI result)
	AuthV4 Adult authentication request result callback Invoked when the UI window is closed. More...

void	com.hive.AuthV4.AuthV4CheckProviderListener.onDeviceProviderInfo (ResultAPI result, ProviderInfo providerInfo)
	AuthV4 Provider status request result callback If the requested provider is not logged in, it tries to login. More...

void	com.hive.AuthV4.AuthV4MaintenanceListener.onAuthV4Maintenance (ResultAPI result, ArrayList< AuthV4MaintenanceInfo > maintenanceInfo)
	AuthV4 Sever maintenance check request result callback Check whether the server is in the server maintenance with the ServerId set in Configuration. More...

void	com.hive.AuthV4.AuthV4ProviderFriendsListener.onGetProviderFriendsList (ResultAPI result, ProviderType providerType, Map< String, Long > providerUserIdList)
	HIVE SDK Provider friend list request result callback result : Result of API. More...

void	com.hive.AuthV4.AuthV4ResolveConflictListener.onAuthV4ResolveConflict (ResultAPI result)
	Result callback of resolveConflict(AuthV4ResolveConflictListener) call AuthV4.resolveConflict() use it. More...

static void	com.hive.AuthV4.setup (AuthV4SetupListener listener)
	AuthV4 Perform initialization. More...

static void	com.hive.AuthV4.signIn (ProviderType providerType, AuthV4SignInListener listener)
	Requests signIn according to the given providerType. More...

static void	com.hive.AuthV4.signOut (AuthV4SignOutListener listener)
	it remove the local session. More...

static void	com.hive.AuthV4.connect (ProviderType providerType, AuthV4ConnectListener listener)
	It connects to the currently requested provider for the currently signed-in user. More...

static void	com.hive.AuthV4.disconnect (ProviderType providerType, AuthV4DisconnectListener listener)
	Releases the currently signed-in user from the requested provider. More...

static void	com.hive.AuthV4.selectConflict (long selectedPlayerId, AuthV4SignInListener listener)
	When an account conflict (CONFLICT_PLAYER) occurs due to connect, it notify the selected user to the SDK. More...

static void	com.hive.AuthV4.resolveConflict (AuthV4ResolveConflictListener listener)
	It resolve the account conflicts(CONFLICT_PLAYER) caused by connect () call. More...

static boolean	com.hive.AuthV4.isAutoSignIn ()
	It returns whether signIn (AUTO) is enabled. More...

static boolean	com.hive.AuthV4.getAgeGateU13 ()

static PlayerInfo	com.hive.AuthV4.getPlayerInfo ()
	It returns information about the currently signed-in user. More...

static void	com.hive.AuthV4.getProfile (ArrayList< Long > playerIdList, AuthV4GetProfileListener listener)
	it returns the profile information of the requested playerIds. More...

static void	com.hive.AuthV4.showSignIn (AuthV4SignInListener listener)
	It shows the UI with a list of providers that can sign-in. More...

static void	com.hive.AuthV4.showConflictSelection (Map< String, Object > currentPlayerData, Map< String, Object > conflictPlayerData, AuthV4SignInListener listener)
	It shows UI to select user in conflict state. More...

static void	com.hive.AuthV4.showProfile (long playerId, AuthV4ShowProfileListener listener)
	It display the profile UI of the requested playerId. More...

static void	com.hive.AuthV4.showCafe (AuthV4ShowCafeListener listener)
	It shows the HIVE Cafe UI. More...

static void	com.hive.AuthV4.showInquiry (AuthV4ShowInquiryListener listener)
	It shows the 1: 1 query UI. More...

static void	com.hive.AuthV4.showTerms (AuthV4ShowTermsListener listener)
	It shows HIVE Terms and Conditions. More...

static void	com.hive.AuthV4.showAdultConfirm (AuthV4AdultConfirmListener listener)
	It request adult authentication. More...

static void	com.hive.AuthV4.checkProvider (ProviderType providerType, AuthV4CheckProviderListener listener)
	It check the status of the requested Provider. More...

static void	com.hive.AuthV4.checkMaintenance (boolean isShow, AuthV4MaintenanceListener listener)
	It display maintenance status and return its data. More...

static void	com.hive.AuthV4.checkBlacklist (boolean isShow, AuthV4MaintenanceListener listener)
	it check the restriction status of the current user. More...

static void	com.hive.AuthV4.setProviderChangedListener (AuthV4CheckProviderListener listener)
	It set a listener to be notified whether the information of the linked Provider has changed. More...

static void	com.hive.AuthV4.reset ()
	It initialize all data used by the SDK, including authentication information. More...

static void	com.hive.AuthV4.getProviderFriendsList (ProviderType providerType, AuthV4ProviderFriendsListener listener)
	It returns the playerId list information of the friends of the connected user corresponding to the input providerType. More...

Detailed Description

Provides HIVE SDK initialization and HIVE authentication functions
The HIVE SDK performs initialization based on the xml configuration file.

Function Documentation

§ checkBlacklist()

static void com.hive.AuthV4.checkBlacklist	(	boolean	isShow,
		AuthV4MaintenanceListener	listener
	)

static

it check the restriction status of the current user.

It is automatically checked when signIn or connect is called and shows a restriction popup,
but you can use it when you need to check in realtime in the app.

On request, the UI is exposed when isShow is true

If the result is SUCCESS but there is no restriction notification, the maintenanceInfo of the listener will be empty.
If isShow is set to false on request, the UI should be configured and exposed by game developer with the maintenanceInfo information of the listener.

Parameters

isShow	Whether to use the HIVE UI
listener	onAuthV4Maintenance

§ checkMaintenance()

static void com.hive.AuthV4.checkMaintenance	(	boolean	isShow,
		AuthV4MaintenanceListener	listener
	)

static

It display maintenance status and return its data.

It checks whether the server is in maintenance with the ServerId set in Configuration.

Once the SDK is initialized, you should check the status of the server maintenance and update.
Server maintenance and Update can block lower version after update of game client, or block game connection during maintenance time of game server.
HIVE provides a function to expose server maintenance or update pop-up according to the information set in the back office.

On request, a maintenance popup UI is exposed when isShow is true.

If the result is SUCCESS but there is no maintenance notification, the maintenanceInfo of the listener will be empty.
If isShow is set to false on request, the UI should be configured and exposed by game developer with the maintenanceInfo information of the listener.

Parameters

listener onAuthV4Maintenance

§ checkProvider()

static void com.hive.AuthV4.checkProvider	(	ProviderType	providerType,
		AuthV4CheckProviderListener	listener
	)

static

It check the status of the requested Provider.

If the requested provider is not logged in, it tries to login.
If the login succeeds, it also brings providerUserId.

It does not request connect with the current playerId.

SUCCESS means that the query was successful and should determine whether or not the user is logged in with the presence of providerUserId in providerInfo.
If you are logged in to the actual provider, there is a providerUserId. Otherwise, only providerType exists.

When using the implicit sign-in : Google Play Games, Apple Game Center etc.

Parameters

providerType	ProviderType to check status
listener	onDeviceProviderInfo

§ connect()

static void com.hive.AuthV4.connect	(	ProviderType	providerType,
		AuthV4ConnectListener	listener
	)

static

It connects to the currently requested provider for the currently signed-in user.

After logging in with the requested provider, if it is successful, it sends an linking request to the authentication server.
If there is a playerId already linked to the UserId of the corresponding provider, a CONFLICT_PLAYER error is returned in the result of the listener.
In this case, you should configured an UI for account selection to the user with the conflict user information of the conflictPlayer object included in the listener.
When the user makes a selection, calls selectConflict () with the selected user information.

If you do not customize the UI, you can use showConflictSelection().
In this case, when the user selects it, it can proceed to selectConflict() and receive the result of the sign-in completed.

When the linking is completed, the corresponding state should be updated on the UI of the app.

In the case of BLACKLIST, SDK will show a restriction popup and issue a BLACKLIST error.

Parameters

providerType ProviderType to request connect.
AUTO or GUEST causes an INVALID_PARAM error.

listener onAuthV4Connect

result :If ProviderType is not supported (INVALID_PARAM)
or if the Sign-in is in progress (IN_PROGRESS), it may fail.
If sign-in fails, an INVALID_SESSION error is returned.
An INVALID_PARAM error will occur if the provider is already connected.
In this case, you must first call disconnect for the provider and then connect again.
CONFLICT_PLAYER is returned if the provider attempting to connect is already connected to another playerId
and the conflictPlayer object returned contains the corresponding conflict user information.
conflictPlayer : If result is CONFLICT_PLAYER, it contains information about the conflicting user.
Only the information of the ProviderInfo that conflicted with playerId is included.
playerToken is empty.

§ disconnect()

static void com.hive.AuthV4.disconnect	(	ProviderType	providerType,
		AuthV4DisconnectListener	listener
	)

static

Releases the currently signed-in user from the requested provider.

It pass the disconnect status to the authentication server and then logout the requested provider.
If delivery fails to the authentication server, if the Sign or setup is in progress,
or if the provider is already disconnected, it may fail.

Note that if all account link are disconnected due to 'disconnect', it may become a guest state.

Parameters

providerType	disconnect 요청할 ProviderType.
listener	onAuthV4Disconnect result : If delivery fails to the authentication server, if the Sign or setup is in progress, or if the provider is already disconnected, it may fail. Otherwise, success.

§ getAgeGateU13()

static boolean com.hive.AuthV4.getAgeGateU13 ( )

static

Deprecated:: 4.10.1

§ getPlayerInfo()

static PlayerInfo com.hive.AuthV4.getPlayerInfo ( )

static

It returns information about the currently signed-in user.

PlayerInfo includes playerToken and profile information (playerName, playerImageUrl),
but it returns the locally cached profile information instead of requesting it to the server in real time upon request.

When getProfile or showProfile is called, it is automatically updated profile information if a signed-in user is it self.

Returns: PlayerInfo Information about the currently signed-in user. Null if not signed-in.

§ getProfile()

static void com.hive.AuthV4.getProfile	(	ArrayList< Long >	playerIdList,
		AuthV4GetProfileListener	listener
	)

static

it returns the profile information of the requested playerIds.

It update playerName and playerImageUrl when the playerId list contains the signed-in oneself.

Parameters

playerIdList	ArrayList<Long>
listener	onAuthV4GetProfile

§ getProviderFriendsList()

static void com.hive.AuthV4.getProviderFriendsList	(	ProviderType	providerType,
		AuthV4ProviderFriendsListener	listener
	)

static

It returns the playerId list information of the friends of the connected user corresponding to the input providerType.

It comes with a pair of information about the providerId of the requested providerType and the playerId of the associated user.
Up to 5000 people for kHIVEProviderTypeFACEBOOK.

You can query your friend's PlayerInfo using getProfile.

@

Parameters

listener AuthV4ProviderFriendsListener

§ isAutoSignIn()

static boolean com.hive.AuthV4.isAutoSignIn ( )

static

It returns whether signIn (AUTO) is enabled.

It is the same value that you would get when you called setup(),
and it only checks for existing sessions that are stored locally, so you do not know if the session token is a valid token that the session has not been expired.
If true, then signIn (AUTO) should be called through UI such as 'TOUCH TO START',
and if signIn(AUTO) fails, it should return to the initial sign-in screen again.

If it is false, you can customize the UI through the providerList provided at setup() call
or use the UI provided by HIVE via showSignIn()

If you return to the sign-in scene such as signOut in the middle of your app, you can check whether you need to configure the UI through this API.

Returns: boolean Whether signIn (AUTO) is enabled.

§ onAuthV4AdultConfirm()

void com.hive.AuthV4.AuthV4AdultConfirmListener.onAuthV4AdultConfirm ( ResultAPI result )

AuthV4 Adult authentication request result callback Invoked when the UI window is closed.

result : INVALID_SESSION can come if you do not have a sign-in because you need a sign-in.
SUCCESS, if you have successfully completed the adult authentication

§ onAuthV4Connect()

void com.hive.AuthV4.AuthV4ConnectListener.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.

If sign-in fails, an INVALID_SESSION error is returned.
An INVALID_PARAM error will occur if the provider is already connected.
In this case, you must first call disconnect for the provider and then connect again.
CONFLICT_PLAYER is returned if the provider attempting to connect is already connected to another playerId
and the conflictPlayer object returned contains the corresponding conflict user information.
conflictPlayer : If result is CONFLICT_PLAYER, it contains information about the conflicting user.
Only the information of the ProviderInfo that conflicted with playerId is included.
playerToken is empty.

§ onAuthV4Disconnect()

void com.hive.AuthV4.AuthV4DisconnectListener.onAuthV4Disconnect ( ResultAPI result )

AuthV4 Provider disconnect result callback It pass the disconnect status to the authentication server and then logout the requested provider.

result : It can fail if the delivery to the authentication server fails, if the Sign-in is in progress, if it is not setup, or if it is already a disconnected Provider.
Otherwise, success.

§ onAuthV4GetProfile()

void com.hive.AuthV4.AuthV4GetProfileListener.onAuthV4GetProfile	(	ResultAPI	result,
		ArrayList< ProfileInfo >	profileInfoList
	)

AuthV4 Profile information request result callback The profile information of the playerIds which are requested to the profile server is returned.

result : Results for request. In case of failure, profileInfoList is empty.
profileInfoList : Profile information for requested playerIds.
Each profile has playerId, playerName, playerImageUrl.

§ onAuthV4Maintenance()

void com.hive.AuthV4.AuthV4MaintenanceListener.onAuthV4Maintenance	(	ResultAPI	result,
		ArrayList< AuthV4MaintenanceInfo >	maintenanceInfo
	)

AuthV4 Sever maintenance check request result callback Check whether the server is in the server maintenance with the ServerId set in Configuration.

If isShow is true on request, the maintenance popup is exposed and this callback will be called after the popup is closed.

result : If the query to the server is successful, it will be SUCCESS.
If it is SUCCESS but there is no notice of maintenance, maintenanceInfo will be empty.
maintenanceInfo : Maintenance popup information about the action that is exposed to the popup.
If isShow is set to false on request, you must make and expose the UI directly by your self with this information.

§ onAuthV4ResolveConflict()

void com.hive.AuthV4.AuthV4ResolveConflictListener.onAuthV4ResolveConflict ( ResultAPI result )

Result callback of resolveConflict(AuthV4ResolveConflictListener) call AuthV4.resolveConflict() use it.

Logging out is not possible for IdPs that can not log out of the app. ex) Apple GameCenter
Therefore, even if the actual IDP logout fails, the internal conflict information is deleted .

See also: resolveConflict(AuthV4ResolveConflictListener)

§ onAuthV4Setup()

void com.hive.AuthV4.AuthV4SetupListener.onAuthV4Setup	(	ResultAPI	result,
		boolean	isAutoSignIn,
		String	did,
		ArrayList< ProviderType >	providerTypeList
	)

AuthV4 initialization result callback result : When initial initialize is executed, it fails if it does not receive DID or Provider List.

Otherwise, it is a success.
isAutoSignIn : Whether there is an old session left on local storage. If true, call SignIn (ProviderType.AUTO).
Otherwise, you can request SignIn as one of providerTypeList.
providerTypeList : A provider list that can be signed in from the current device.
And may be different depending on the current area (IP) of the device.
GUEST is included, and in some areas or environments GUEST may not be possible.

§ onAuthV4ShowCafe()

void com.hive.AuthV4.AuthV4ShowCafeListener.onAuthV4ShowCafe ( ResultAPI result )

AuthV4 Cafe UI request result callback Invoked when the UI window is closed.

result : NEED_INITIALIZE can occur if 'setup' has not been called. Otherwise, success.

§ onAuthV4ShowInquiry()

void com.hive.AuthV4.AuthV4ShowInquiryListener.onAuthV4ShowInquiry ( ResultAPI result )

AuthV4 1:1 Inquiry UI request result callback Invoked when the UI window is closed.

result : NEED_INITIALIZE can occur if 'setup' has not been called. Otherwise, success.

§ onAuthV4ShowProfile()

void com.hive.AuthV4.AuthV4ShowProfileListener.onAuthV4ShowProfile ( ResultAPI result )

AuthV4 Profile UI request result callback Invoked when the UI window is closed.

result : If the entered playerId is not of the wrong type, it succeeds

§ onAuthV4ShowTerms()

void com.hive.AuthV4.AuthV4ShowTermsListener.onAuthV4ShowTerms ( ResultAPI result )

AuthV4 Terms of Service UI request result callback Invoked when the UI window is closed.

result : NEED_INITIALIZE can occur if 'setup' has not been called. Otherwise, success.

§ onAuthV4SignIn()

void com.hive.AuthV4.AuthV4SignInListener.onAuthV4SignIn	(	ResultAPI	result,
		PlayerInfo	playerInfo
	)

AuthV4 Sign-in result callback result : If it is not SUCCESS, you should return to the login screen again.

If the session has expired or is not normal, INVALID_SESSION is returned,
or CANCELED if the user cancels the external login window.
NETWORK or TIMEOUT can be caused by delay of server response,
and for other failures are RESPONSE_FAIL.
playerInfo : If result is SUCCESS, the playerInfo contains information about the user who successfully signed in.
providerInfoData contains the information of the connected Provider. The missing Provider is not connected.

§ onAuthV4SignOut()

void com.hive.AuthV4.AuthV4SignOutListener.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.
그 외 성공

§ onDeviceProviderInfo()

void com.hive.AuthV4.AuthV4CheckProviderListener.onDeviceProviderInfo	(	ResultAPI	result,
		ProviderInfo	providerInfo
	)

AuthV4 Provider status request result callback If the requested provider is not logged in, it tries to login.

It does not request connect with the current playerId.

result : SUCCESS means that the query was successful and you can determine whether the requested user is a logged-in user or not by whether providerInfo has a providerUserId.
providerInfo : If you are logged in to the actual provider, there is a providerUserId. Otherwise, only providerType exists.

§ onGetProviderFriendsList()

void com.hive.AuthV4.AuthV4ProviderFriendsListener.onGetProviderFriendsList	(	ResultAPI	result,
		ProviderType	providerType,
		Map< String, Long >	providerUserIdList
	)

HIVE SDK Provider friend list request result callback result : Result of API.

In case of failure, providerUserIdList is empty.
providerType : The ProviderType requested when calling the API.
providerUserIdList : The requested providerUserId list.

§ reset()

static void com.hive.AuthV4.reset ( )

static

It initialize all data used by the SDK, including authentication information.

It is used for HIVE SDK implementation and testing.

§ resolveConflict()

static void com.hive.AuthV4.resolveConflict ( AuthV4ResolveConflictListener listener )

static

It resolve the account conflicts(CONFLICT_PLAYER) caused by connect () call.

This is used when the customized UI is used in the account conflict state caused by connect() call.
It resolve the account conflicts(CONFLICT_PLAYER).
Upon calling, the corresponding IdP (Provider) is logged out.
For an Apple GameCenter (IDP) that can not log out of the app, you can not sign out,
and only delete internal conflict information.

Parameters

listener AuthV4ResolveConflictListener
Even if the actual IdP logout fails, the internal conflict information is deleted.

See also: AuthV4.AuthV4ResolveConflictListener

§ selectConflict()

static void com.hive.AuthV4.selectConflict	(	long	selectedPlayerId,
		AuthV4SignInListener	listener
	)

static

When an account conflict (CONFLICT_PLAYER) occurs due to connect, it notify the selected user to the SDK.

If you use your own customized UI for an account conflict situation (CONFLICT_PLAYER),
you need to call it to notify the selected user when user select one.
INVALID_PARAM can occur if the SDK state is not in a conflict state, signIn is in progress, or the wrong playerId.
Even if a conflict occurs, the existing user is considered to be signIn until selectConflict () is called then sign in.

You do not need to call it if you use showConflictSelection().

Parameters

selectedPlayerId	PlayerId of the selected user
listener	onAuthV4SignIn Note: The existing user is a signined user, until SUCCESS.

§ setProviderChangedListener()

static void com.hive.AuthV4.setProviderChangedListener ( AuthV4CheckProviderListener listener )

static

It set a listener to be notified whether the information of the linked Provider has changed.

For Google Play Games and Apple Game Center, account information may be changed outside of the app.
That's why it checks to see if the user information has changed when the app resumes (onStart),
and if so, the callback is called.

Callbacks will work after checkProvider() or attempting to connect directly with connect().

If you implement implicit sign-in, you need to check directly with checkProvider () at the completion of signIn().

Parameters

listener onDeviceProviderInfo

§ setup()

static void com.hive.AuthV4.setup ( AuthV4SetupListener listener )

static

AuthV4 Perform initialization.

It should be called first among all the APIs except for the configuration area,
and if this is not called first, some API may cause a NEED_INITIALIZE error.
On Android, the permission request UI is exposed
Afterwards, consent to the Terms, download check, DID setting, config.xml setting, ProviderList setting and etc. are performed.
If the DID is not received on the first execution, or the provider list is not received, the result is sent to the listener as failure.
You need to configure the UI for signIn using the providerTypeList contained in listener.
If you do not implement the UI directly, use showSignIn().

When the setup of AuthV4 is called, the functions of the existing Auth and Social areas are disabled.
In the opposite case, when Auth is initialized, AuthV4 and Provider areas are disabled.
Required VID for other functional units (Push, Pomotion, IAP, etc.), you need to insert the playerId instead,if you set up with AuthV4.

Parameters

listener onAuthV4Setup AuthV4 Setup request result callback
result : If the DID is not received or the provider list is not received, it fails. Otherwise, success.
isAutoSignIn : Whether an old session remains local storage. If true, call SignIn (ProviderType.AUTO).
Otherwise, you can request SignIn as one of providerTypeList.
providerTypeList : A provider list that can be signed in at the current device.
And may be different depending on the current area (IP) of the device.
GUEST is included, and in some areas or environments GUEST may not be possible.

§ showAdultConfirm()

static void com.hive.AuthV4.showAdultConfirm ( AuthV4AdultConfirmListener listener )

static

It request adult authentication.

For some games that require adult authentication, it provide adult authentication.

Parameters

listener onAuthV4AdultConfirm
result : INVALID_SESSION can be given if it is not signed-in because it requires a sign-in.
SUCCESS will be made if the adult is successfully certified.

§ showCafe()

static void com.hive.AuthV4.showCafe ( AuthV4ShowCafeListener listener )

static

It shows the HIVE Cafe UI.

It can be used regardless of whether HIVE Membership is linked or not,
and if it is linked, My Cafes menu is added.

Parameters

listener onAuthV4ShowCafe

§ showConflictSelection()

static void com.hive.AuthV4.showConflictSelection	(	Map< String, Object >	currentPlayerData,
		Map< String, Object >	conflictPlayerData,
		AuthV4SignInListener	listener
	)

static

It shows UI to select user in conflict state.

If a CONFLICT_PLAYER error occurs during connect() call, it shows the UI to display a user-selectable UI.
It should be called with information (nickname, level, etc.) that identifies the user corresponding to the conflicted playerId.
You should put the playerId in the "player_id" key in playerData.
For other information, add a value of type Map <String, Object> to the "game_data" key.
The keys name, "player_id" and "game_data" are required and should not be changed.

ex) {"player_id":123, "game_data":{"Name":"CurrentPlayer", "Level":52}}

If a conflicted user is selected, the game data corresponding to the user must be reloaded.

Parameters

currentPlayerData	Information of the user who is currently signed in.
conflictPlayerData	ConflictPlayer information received at connect() call.
listener	onAuthV4SignIn

§ showInquiry()

static void com.hive.AuthV4.showInquiry ( AuthV4ShowInquiryListener listener )

static

It shows the 1: 1 query UI.

It can be used regardless of whether HIVE Membership is linked or not,
If it is linked, the e-mail part is automatically filled in.

Parameters

listener onAuthV4ShowInquiry

§ showProfile()

static void com.hive.AuthV4.showProfile	(	long	playerId,
		AuthV4ShowProfileListener	listener
	)

static

It display the profile UI of the requested playerId.

If the playerId is a sign-in user's one and the user is a member of HIVE Membership, the user can change the profile picture and nickname in this UI.
In this case, when the window is closed, the playerName and playerImageUrl are synchronized with the local information.

Parameters

playerId	PlayerId to show the profile UI
listener	onAuthV4ShowProfile

§ showSignIn()

static void com.hive.AuthV4.showSignIn ( AuthV4SignInListener listener )

static

It shows the UI with a list of providers that can sign-in.

It will show a UI with the same list of providers as the ProviderList you received from setup() call.
A GUEST button may not be exposed due to network delays.
AUTO is not supported. If isAutoSignIn () is true, call signIn(AUTO) immediately.

Parameters

listener onAuthV4SignIn

§ showTerms()

static void com.hive.AuthV4.showTerms ( AuthV4ShowTermsListener listener )

static

It shows HIVE Terms and Conditions.

It shows Terms and Conditions
At initialization of the SDK, the user will go through the agreement process.
After this, the game should be configured to expose the WebView os that user can check Privacy policy and Terms and Conditions in the game setting menu.

Parameters

listener onAuthV4ShowTerms
API callback

§ signIn()

static void com.hive.AuthV4.signIn	(	ProviderType	providerType,
		AuthV4SignInListener	listener
	)

static

Requests signIn according to the given providerType.

If there is a locally stored session and it is not AUTO
or if there is no session stored locally and it is AUTO, it will cause INVALID_PARAM error.
You can also check whether it is AUTO or not with isAutoSignIn ().
IN_PROGRESS occurs when the sign-in is already in progress,
and the external authentication window can be exposed once again for ProviderType other than GUEST.

If signIn succeeds, you can get the user information through the playerInfo contained in the listener
and display the status of the linked provider in the UI

In the case of signIn (AUTO), since it is sign-in only with the session of the stored playerId,
you should call checkProvider () to check whether the provider performing the implicit login is also logged in the actual terminal and to synchronize the account.
If it is different, you can call signOut () and call signIn (Provider) to switch the account.

In the case of BLACKLIST, SDK will pop up a restriction popup and issue a BLACKLIST error.

Parameters

providerType	ProviderType to request signIn
listener	onAuthV4SignIn AuthV4 signIn result callback

§ signOut()

static void com.hive.AuthV4.signOut ( AuthV4SignOutListener listener )

static

it remove the local session.

It logs out all the providers that are logged in, removes the local session and gives a success callback regardless of the result.
IN_PROGRESS may occur when signIn / Out is in progress

Note that in the case of a player in the guest state (no connected Provider), the player will not be able to sign in again.

Parameters

listener onAuthV4SignOut Sign-out result callback

HIVE SDK for Android

Classes

Functions

Detailed Description

Function Documentation

§ checkBlacklist()

§ checkMaintenance()

§ checkProvider()

§ connect()

§ disconnect()

§ getAgeGateU13()

§ getPlayerInfo()

§ getProfile()

§ getProviderFriendsList()

§ isAutoSignIn()

§ onAuthV4AdultConfirm()

§ onAuthV4Connect()

§ onAuthV4Disconnect()

§ onAuthV4GetProfile()

§ onAuthV4Maintenance()

§ onAuthV4ResolveConflict()

§ onAuthV4Setup()

§ onAuthV4ShowCafe()

§ onAuthV4ShowInquiry()

§ onAuthV4ShowProfile()

§ onAuthV4ShowTerms()

§ onAuthV4SignIn()

§ onAuthV4SignOut()

§ onDeviceProviderInfo()

§ onGetProviderFriendsList()

§ reset()

§ resolveConflict()

§ selectConflict()

§ setProviderChangedListener()

§ setup()

§ showAdultConfirm()

§ showCafe()

§ showConflictSelection()

§ showInquiry()

§ showProfile()

§ showSignIn()

§ showTerms()

§ signIn()

§ signOut()