HIVE SDK for iOS

Classes | Typedefs | Functions
Auth

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

Classes

class  HIVEAccount
 HIVE authentication user information. More...
 
class  HIVEAuthInitResult
 Information to be delivered when the result is notified after HIVE SDK initialization. More...
 
class  HIVEAuthMaintenanceInfo
 Server maintenance and update status information. More...
 
class  HIVEAuth
 Provides HIVE SDK initialization and HIVE authentication functions
The HIVE SDK performs initialization based on the xml configuration file. More...
 

Typedefs

typedef void(^ HIVEAuthInitializeHandler) (HIVEResultAPI *result, HIVEAuthInitResult *authInitResult)
 Notify HIVE SDK initialization result listener. More...
 
typedef void(^ HIVEAuthLoginHandler) (HIVEResultAPI *result, HIVELoginType loginType, HIVEAccount *currentAccount, HIVEAccount *usedAccount)
 HIVE login result listener. More...
 
typedef void(^ HIVEAuthLogoutHandler) (HIVEResultAPI *result)
 HIVE logout result listener. More...
 
typedef void(^ HIVEAuthMaintenanceHandler) (HIVEResultAPI *result, HIVEAuthMaintenanceInfo *maintenanceInfo)
 Maintenance popup result. More...
 
typedef void(^ HIVEAuthShowTermsHandler) (HIVEResultAPI *result)
 The result of displaying the terms and conditions. More...
 
typedef void(^ HIVEAuthAdultConfirmHandler) (HIVEResultAPI *result)
 Adult verification pop-up result. More...
 

Functions

typedef NS_ENUM (NSUInteger, HIVELoginType)
 HIVE login type definition. More...
 
typedef NS_ENUM (NSUInteger, HIVEAuthMaintenanceActionType)
 Definition of actions to be taken when the button is pressed on the maintenance popup. More...
 
(void) + HIVEAuth::initialize:
 Initialize HIVE SDK
If the app is launched for the first time, you will be exposed to the terms and acceptance process. More...
 
(HIVELoginType) + HIVEAuth::getLoginType
 After initializing the SDK, it returns the login information that can be executed according to the existing login information. More...
 
(void) + HIVEAuth::login:handler:
 Request HIVE login according to given login type. More...
 
(void) + HIVEAuth::showLoginSelection:usedData:handler:
 Performing a HIVE login while logged in as a guest may result in account conflicts and require the user to switch HIVE accounts. More...
 
(void) + HIVEAuth::bindLogin:handler:
 If the user selects one of the conflicting HIVE accounts, the result must be sent to the HIVE authentication server. More...
 
(void) + HIVEAuth::logout:
 Once you have completed your HIVE login, you are issued a user's unique ID, VID, and session key. More...
 
(HIVEAccount *) + HIVEAuth::getAccount
 Returns the authentication information of HIVE user. More...
 
(void) + HIVEAuth::showTerms:
 Display HIVE Terms and Conditions. More...
 
(void) + HIVEAuth::checkMaintenance:handler:
 Display the maintenance status and return data. More...
 
(void) + HIVEAuth::showAdultConfirm:
 Request adult verification. More...
 
(void) + HIVEAuth::reset
 Initialize all data used by the SDK, including authentication information. More...
 
(void) + HIVEAuth::requestPermissionViewData:
 권한고지 팝업을 구성하기 위한 데이터를 얻습니다. More...
 
typedef NS_ENUM (NSUInteger, HIVEAuthV4MaintenanceDialogType)
 

Detailed Description

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



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

The detailed functions provided by this class are as follows.

Typedef Documentation

§ HIVEAuthAdultConfirmHandler

typedef void(^ HIVEAuthAdultConfirmHandler) (HIVEResultAPI *result)

Adult verification pop-up result.

Parameters
resultAPI call result

§ HIVEAuthInitializeHandler

typedef void(^ HIVEAuthInitializeHandler) (HIVEResultAPI *result, HIVEAuthInitResult *authInitResult)

Notify HIVE SDK initialization result listener.

Parameters
resultAPI call result
authInitResultHIVE SDK initialization result

§ HIVEAuthLoginHandler

typedef void(^ HIVEAuthLoginHandler) (HIVEResultAPI *result, HIVELoginType loginType, HIVEAccount *currentAccount, HIVEAccount *usedAccount)

HIVE login result listener.

Parameters
resultAPI call result
loginTypeHIVE login type according to HIVE login result
If loginType is LoginType.SELECT, it should ask user selection according to HIVE account conflict.
currentAccountHIVE account information of user who completed HIVE login
usedAccountHive account information of user who registered in HIVE authentication server

§ HIVEAuthLogoutHandler

typedef void(^ HIVEAuthLogoutHandler) (HIVEResultAPI *result)

HIVE logout result listener.

Parameters
resultAPI call result

§ HIVEAuthMaintenanceHandler

typedef void(^ HIVEAuthMaintenanceHandler) (HIVEResultAPI *result, HIVEAuthMaintenanceInfo *maintenanceInfo)

Maintenance popup result.

Parameters
resultAPI call result
authMaintenanceInfoData for pop-ups in game

§ HIVEAuthShowTermsHandler

typedef void(^ HIVEAuthShowTermsHandler) (HIVEResultAPI *result)

The result of displaying the terms and conditions.

Parameters
resultAPI call result

Function Documentation

§ bindLogin:handler:()

+ (void) bindLogin: (NSString *)  selectedVid
handler: (HIVEAuthLoginHandler handler 

If the user selects one of the conflicting HIVE accounts, the result must be sent to the HIVE authentication server.


Calling this method sends the result to the HIVE authentication server with the given user's unique ID.

Parameters
selectedVidThe unique ID of the user selected by the user
handlerAPI call result handler

§ checkMaintenance:handler:()

+ (void) checkMaintenance: (BOOL)  isShow
handler: (HIVEAuthMaintenanceHandler handler 

Display the maintenance status and return data.

점검 상태 표시 및 데이터 변환


When the HIVE SDK initialization is completed, you need to check the server maintenance and update status.
Server maintenance and update can block lower version after update of game client, or block game connection during game server maintenance time.
HIVE provides a function to show popups in the order of server maintenance, game forced update and notice in accordance with the information set in the back office.

Parameters
isShowWhether to show maintenance popups in HIVE SDK
If this value is true, maintenance popup UI provided by HIVE SDK is used, if false, data for customizing UI is received.
handlerAPI call result handler
isShow점검 팝업 UI를 HIVESDK에서 보여줄지 여부
handlerAPI call listener

§ getAccount()

+ (HIVEAccount *) getAccount

Returns the authentication information of HIVE user.

인증된 사용자 정보 반환

Returns
The authentication information of HIVE user
See also
Account
Returns
사용자 정보
See also
Account

§ getLoginType()

+ (HIVELoginType) getLoginType

After initializing the SDK, it returns the login information that can be executed according to the existing login information.

Auth.initialize() 메서드 호출 후 SDK 가 초기화 되면 기존에 로그인한 정보에 따라서 수행할 수 있는 로그인 정보를 얻을 수 있다.

Returns
Possible login type

이 메서드는 수행 가능한 로그인 정보를 반환한다.

Returns
수행 가능한 로그인 정보

§ initialize:()

+ (void) initialize: (HIVEAuthInitializeHandler handler

Initialize HIVE SDK
If the app is launched for the first time, you will be exposed to the terms and acceptance process.

플랫폼 객체 생성 및 초기화

Parameters
handlerAPI call result
handlerAPI 호출 결과를 받을 리스너

§ login:handler:()

+ (void) login: (HIVELoginType)  loginType
handler: (HIVEAuthLoginHandler handler 

Request HIVE login according to given login type.

HIVE 게스트/계정 로그인 요청

Parameters
loginTypeGUEST : HIVE Guest login
ACCOUNT : HIVE Login
AUTO : Auto Login (session key remains in the device)
handlerAPI call result
authType게스트/계정 로그인 선택
handlerAPI 호출 결과를 받을 리스너
See also
AuthType

§ logout:()

+ (void) logout: (HIVEAuthLogoutHandler handler

Once you have completed your HIVE login, you are issued a user's unique ID, VID, and session key.

HIVE 로그 아웃 요청


     * When requesting logout, it initializes VID and session key
(Note: Never logout at guest login)

Parameters
handlerAPI call result handler
handlerAPI 호출 결과를 받을 리스너

§ NS_ENUM() [1/3]

typedef NS_ENUM ( NSUInteger  ,
HIVELoginType   
)

HIVE login type definition.

< kHIVELoginTypeGUEST 게스트 로그인

< kHIVELoginTypeACCOUNT 정식 로그인

< kHIVELoginTypeSELECT 계정 선택

< kHIVELoginTypeAUTO 자동 로그인

§ NS_ENUM() [2/3]

typedef NS_ENUM ( NSUInteger  ,
HIVEAuthMaintenanceActionType   
)

Definition of actions to be taken when the button is pressed on the maintenance popup.

< kHIVEAuthMaintenanceActionTypeOPEN_URL 외부 부라우저로 전달된 url 을 실행

< kHIVEAuthMaintenanceActionTypeEXIT 앱 강제 종료.

< kHIVEAuthMaintenanceActionTypeDONE 아무것도 하지 않음

§ NS_ENUM() [3/3]

typedef NS_ENUM ( NSUInteger  ,
HIVEAuthV4MaintenanceDialogType   
)

< kHIVEAuthMaintenanceDialogDefault 점검류의 팝업.

< kHIVEAuthMaintenanceDialogTypeBlacklist 유저제재의 팝업.

§ requestPermissionViewData:()

+ (void) requestPermissionViewData: ("Use Configration.getPermissionViewData")  __deprecated_msg

권한고지 팝업을 구성하기 위한 데이터를 얻습니다.


HIVEResultAPI의 result가 success이며, result의 code가 kAuthV4SkipPermissionView 혹은 kAuthSkipPermissionView가 아닐 경우 권한고지 데이터를 이용하여 권한고지를 출력 할 수있습니다. HIVEPermissionViewData를 참조하여 데이터를 이용하여 UI를 구성하세요. 이 함수를 호출하여 권한고지팝업을 구성할 시 AuthV4.setup, Auth.initialize를 호출하였을때 HIVE SDK의 권한고지 팝업은 나오지 않습니다.

Warning
code가 kAuthV4SkipPermissionView 혹은 kAuthSkipPermissionView가 왔을 경우 HIVEPermissionViewData에는 빈값이 오게됩니다. 값을 참조할 경우 예기치못한 오류가 발생할 수 있으므로 주의 해주세요. 또한 위 코드는 HIVEResultAPI Success일 경우만 오게됩니다.
See also
HIVEPermissionViewData
HIVEResultAPI
Parameters
handler성인 인증 결과 통지

§ reset()

+ (void) reset

Initialize all data used by the SDK, including authentication information.

인증 정보를 포함하여 SDK 에서 사용하는 모든 데이터 초기화


Used for HIVE SDK interworking and testing.

§ showAdultConfirm:()

+ (void) showAdultConfirm: (HIVEAuthAdultConfirmHandler handler

Request adult verification.

성인 인증 표시


For some games that require adult verification, such as GoStop / poker, adult verification is provided.

Parameters
handlerAdult verification result handler
handlerAPI call handler.

§ showLoginSelection:usedData:handler:()

+ (void) showLoginSelection: (NSDictionary <NSString *, NSObject *> *)  currentData
usedData: (NSDictionary<NSString *,NSObject *> *)  usedData
handler: (HIVEAuthLoginHandler handler 

Performing a HIVE login while logged in as a guest may result in account conflicts and require the user to switch HIVE accounts.


Calling this method shows a dialog box to the user to select one of the conflicting accounts.

Parameters
currentDataInformation of logged in user
usedDataUser information registered in HIVE authentication server
handlerAPI call result

§ showTerms:()

+ (void) showTerms: (HIVEAuthShowTermsHandler handler

Display HIVE Terms and Conditions.

약관 정보 표시


When HIVE SDK is initialized, the user will go through the agreement process.
After this, the game should expose Personal information processing policies and terms and services in the game settings.

Parameters
handlerAPI call result handler
handlerAPI 호출 결과 통지 리스너
Copyright © GAMEVIL COM2US PLATFORM Inc. All Right Reserved. Terms of Use Privacy Policy