HIVE SDK for iOS

클래스 | 타입정의 | 함수
Auth

HIVE SDK 초기화 및 HIVE 인증 기능을 제공한다
HIVE SDK 는 xml 설정 파일을 기반으로 초기화를 수행한다. 더 자세히 ...

클래스

class  HIVEAccount
 HIVE 인증 사용자 정보 더 자세히 ...
 
class  HIVEAuthInitResult
 HIVE SDK 초기화 후 결과 통지시 전달되는 정보 더 자세히 ...
 
class  HIVEAuthMaintenanceInfo
 서버 점검 및 업데이트 상태 표시 정보 더 자세히 ...
 
class  HIVEAuth
 HIVE SDK 초기화 및 HIVE 인증 기능을 제공한다
HIVE SDK 는 xml 설정 파일을 기반으로 초기화를 수행한다. 더 자세히 ...
 

타입정의

typedef void(^ HIVEAuthInitializeHandler) (HIVEResultAPI *result, HIVEAuthInitResult *authInitResult)
 HIVE SDK 초기화 결과 통지 더 자세히 ...
 
typedef void(^ HIVEAuthLoginHandler) (HIVEResultAPI *result, HIVELoginType loginType, HIVEAccount *currentAccount, HIVEAccount *usedAccount)
 HIVE 로그인 결과 통지 더 자세히 ...
 
typedef void(^ HIVEAuthLogoutHandler) (HIVEResultAPI *result)
 HIVE 로그 아웃 결과 통지 더 자세히 ...
 
typedef void(^ HIVEAuthMaintenanceHandler) (HIVEResultAPI *result, HIVEAuthMaintenanceInfo *maintenanceInfo)
 점검 팝업 결과 통지 더 자세히 ...
 
typedef void(^ HIVEAuthShowTermsHandler) (HIVEResultAPI *result)
 약관 정보 표시 결과 통지 더 자세히 ...
 
typedef void(^ HIVEAuthAdultConfirmHandler) (HIVEResultAPI *result)
 성인 인증 팝업 결과 통지 더 자세히 ...
 

함수

typedef NS_ENUM (NSUInteger, HIVELoginType)
 HIVE 로그인 형태 정의 더 자세히 ...
 
typedef NS_ENUM (NSUInteger, HIVEAuthMaintenanceActionType)
 점검 화면에서 버튼을 눌렀을때 동작될 행동 더 자세히 ...
 
(void) + HIVEAuth::initialize:
 HIVE SDK 초기화 수행
만약 앱이 처음 실행된 경우라면 약관을 노출하고 동의를 받는 과정을 거치게 된다 더 자세히 ...
 
(HIVELoginType) + HIVEAuth::getLoginType
 SDK 초기화 후 기존에 로그인한 정보에 따라서 수행할 수 있는 로그인 정보를 반환한다. 더 자세히 ...
 
(void) + HIVEAuth::login:handler:
 주어진 로그인 타입에 따라서 HIVE 로그인을 요청한다. 더 자세히 ...
 
(void) + HIVEAuth::showLoginSelection:usedData:handler:
 게스트 로그인 상태에서 HIVE 로그인을 수행하면 계정 충돌이 발생 할 수 있으며, 유저에게 HIVE 계정 전환을 요청 해야 한다. 더 자세히 ...
 
(void) + HIVEAuth::bindLogin:handler:
 유저가 충돌난 HIVE 계정 중 하나를 선택하면 HIVE 인증 서버에 결과를 전송해야 한다. 더 자세히 ...
 
(void) + HIVEAuth::logout:
 HIVE 로그인을 완료 하였으면 유저의 고유 ID 인 VID 와 세션키가 발급된 상태이다. 더 자세히 ...
 
(HIVEAccount *) + HIVEAuth::getAccount
 HIVE 유저의 인증 정보 반환한다 더 자세히 ...
 
(void) + HIVEAuth::showTerms:
 HIVE 약관 정보를 표시한다. 더 자세히 ...
 
(void) + HIVEAuth::checkMaintenance:handler:
 점검 상태 표시 및 데이터 반환한다. 더 자세히 ...
 
(void) + HIVEAuth::showAdultConfirm:
 성인 인증을 요청한다. 더 자세히 ...
 
(void) + HIVEAuth::reset
 인증 정보를 포함하여 SDK 에서 사용하는 모든 데이터 초기화 한다. 더 자세히 ...
 
(void) + HIVEAuth::requestPermissionViewData:
 권한고지 팝업을 구성하기 위한 데이터를 얻습니다. 더 자세히 ...
 
typedef NS_ENUM (NSUInteger, HIVEAuthV4MaintenanceDialogType)
 점검류의 화면인지 유저 제재(블랙리스트) 화면인지 구분. 더 자세히 ...
 

상세한 설명

HIVE SDK 초기화 및 HIVE 인증 기능을 제공한다
HIVE SDK 는 xml 설정 파일을 기반으로 초기화를 수행한다.


HIVE SDK 초기화 및 HIVE 인증 기능을 제공한다
HIVE SDK 는 xml 설정 파일을 기반으로 초기화를 수행한다.

이 클래스에서 제공하는 상세 기능은 다음과 같다.

타입정의 문서화

§ HIVEAuthAdultConfirmHandler

typedef void(^ HIVEAuthAdultConfirmHandler) (HIVEResultAPI *result)

성인 인증 팝업 결과 통지

매개변수
resultAPI 호출 결과

§ HIVEAuthInitializeHandler

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

HIVE SDK 초기화 결과 통지

매개변수
resultAPI 호출 결과
authInitResultHIVE SDK 의 초기화 수행 결과

§ HIVEAuthLoginHandler

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

HIVE 로그인 결과 통지

매개변수
resultAPI 호출 결과
loginTypeHIVE 로그인 결과에 따른 HIVE 로그인 형태
만약 loginType 이 LoginType.SELECT 일 경우 HIVE 계정 충돌에 따른 유저 선택을 요청해야 한.
currentAccountHIVE 로그인이 완료된 유저의 HIVE 계정 정보
usedAccountHIVE 인증 서버에 등록된 유저의 HIVE 계정 정보

§ HIVEAuthLogoutHandler

typedef void(^ HIVEAuthLogoutHandler) (HIVEResultAPI *result)

HIVE 로그 아웃 결과 통지

매개변수
resultAPI 호출 결과

§ HIVEAuthMaintenanceHandler

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

점검 팝업 결과 통지

매개변수
resultAPI 호출 결과
authMaintenanceInfo점검 팝업을 게엠에서 띄우기 위한 데이터

§ HIVEAuthShowTermsHandler

typedef void(^ HIVEAuthShowTermsHandler) (HIVEResultAPI *result)

약관 정보 표시 결과 통지

매개변수
resultAPI 호출 결과

함수 문서화

§ bindLogin:handler:()

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

유저가 충돌난 HIVE 계정 중 하나를 선택하면 HIVE 인증 서버에 결과를 전송해야 한다.


이 메서드를 호출하면 주어진 유저의 고유 ID 로 HIVE 인증 서버에 결과를 전송 한다.

매개변수
selectedVid유저가 선택한 유저의 고유 ID
handlerAPI 호출 결과 통지

§ checkMaintenance:handler:()

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

점검 상태 표시 및 데이터 반환한다.


HIVE SDK 의 초기화가 완료되면 서버 점검 및 업데이트 상태를 확인해야 한다.
서버 점검 및 업데이트는 게임 클라이언트의 업데이트 후에 하위 버전을 차단하거나, 게임 서버의 점검 시간 동안 게임 접속을 차단할 수 있다.
HIVE는 백오피스에 설정된 정보에 따라 서버 점검, 게임 강제 업데이트, 공지 순으로 팝업을 노출하는 기능을 제공한다.

매개변수
isShowHIVE SDK 에서 점검 팝업을 노출할지 여부
만약 이 값이 true 이면 HIVE SDK 에서 제공 하는 점검 팝업 UI 사용, false 이면 커스터마이징 UI 를 위한 데이터를 수신한다.
handlerAPI 호출 결과 통지

§ getAccount()

+ (HIVEAccount *) getAccount

HIVE 유저의 인증 정보 반환한다

반환값
HIVE 유저의 인증 정보
참고
Account

§ getLoginType()

+ (HIVELoginType) getLoginType

SDK 초기화 후 기존에 로그인한 정보에 따라서 수행할 수 있는 로그인 정보를 반환한다.

반환값
수행 가능한 로그인 정보

§ initialize:()

+ (void) initialize: (HIVEAuthInitializeHandler handler

HIVE SDK 초기화 수행
만약 앱이 처음 실행된 경우라면 약관을 노출하고 동의를 받는 과정을 거치게 된다

매개변수
handlerAPI 호출 결과 통지

§ login:handler:()

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

주어진 로그인 타입에 따라서 HIVE 로그인을 요청한다.

매개변수
loginTypeGUEST : HIVE 게스트 로그인
ACCOUNT : HIVE 로그인
AUTO : 자동 로그인 선택 게스트 로그인이나 HIVE 로그인되어 있는 상태 (단말에 세션키가 남아 있는 상태)
handlerAPI 호출 결과 통지

§ logout:()

+ (void) logout: (HIVEAuthLogoutHandler handler

HIVE 로그인을 완료 하였으면 유저의 고유 ID 인 VID 와 세션키가 발급된 상태이다.


로그 아웃을 요청하면 VID 와 세션키를 초기화 하는 기능을 수행한다
(주의 : 게스트 로그인시에는 절대 로그 아웃 금지)

매개변수
handlerAPI 호출 결과 통지

§ NS_ENUM() [1/3]

typedef NS_ENUM ( NSUInteger  ,
HIVELoginType   
)

HIVE 로그인 형태 정의

< kHIVELoginTypeGUEST 게스트 로그인

< kHIVELoginTypeACCOUNT 정식 로그인

< kHIVELoginTypeSELECT 계정 선택

< kHIVELoginTypeAUTO 자동 로그인

§ NS_ENUM() [2/3]

typedef NS_ENUM ( NSUInteger  ,
HIVEAuthMaintenanceActionType   
)

점검 화면에서 버튼을 눌렀을때 동작될 행동

< 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의 권한고지 팝업은 나오지 않습니다.

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

§ reset()

+ (void) reset

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


HIVE SDK 연동 및 테스트시에 사용된다.

§ showAdultConfirm:()

+ (void) showAdultConfirm: (HIVEAuthAdultConfirmHandler handler

성인 인증을 요청한다.


고스톱 / 포커류와 같이 성인 인증이 필요한 일부 게임의 경우 성인 인증 기능을 제공한다.

매개변수
handler성인 인증 결과 통지

§ showLoginSelection:usedData:handler:()

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

게스트 로그인 상태에서 HIVE 로그인을 수행하면 계정 충돌이 발생 할 수 있으며, 유저에게 HIVE 계정 전환을 요청 해야 한다.

이 메서드 호출하면 유저에게 충돌난 계정 중 하나를 선택하기 위한 대화 상자 노출 하게 된다.

매개변수
currentData로그인 되어 있는 유저의 정보
usedDataHIVE 인증 서버에 등록된 유저 정보
handlerAPI 호출 결과 통지

§ showTerms:()

+ (void) showTerms: (HIVEAuthShowTermsHandler handler

HIVE 약관 정보를 표시한다.


HIVE SDK 초기화 시 사용자에게 약관 동의 절차를 거치게 된다.
이후 게임에서는 설정 창 등에서 개인 정보 처리 방침 및 이용 약관 정보를 확인할 수 있는 웹뷰를 노출하도록 구성해야 한다.

매개변수
handlerAPI 호출 결과 통지
Copyright © GAMEVIL COM2US PLATFORM Inc. All Right Reserved. 이용약관 개인정보 처리방침