HIVE SDK for C++

클래스 | 타입정의 | 열거형 타입 | 함수
Auth

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

클래스

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

타입정의

typedef std::function< void(ResultAPI const &result, AuthInitResult const &authInitResult)> Auth::onAuthInitialize
 HIVE SDK 초기화 결과 통지 더 자세히 ...
 
typedef std::function< void(ResultAPI const &result, LoginType loginType, Account const &currentAccount, Account const &usedAccount)> Auth::onAuthLogin
 HIVE 로그인 결과 통지 더 자세히 ...
 
typedef std::function< void(ResultAPI const &result)> Auth::onAuthLogout
 HIVE 로그 아웃 결과 통지 더 자세히 ...
 
typedef std::function< void(ResultAPI const &result)> Auth::onAuthShowTerms
 약관 정보 표시 결과 통지 더 자세히 ...
 
typedef std::function< void(ResultAPI const &result, AuthMaintenanceInfo const &authMaintenanceInfo)> Auth::onAuthMaintenance
 점검 팝업 결과 통지 더 자세히 ...
 
typedef std::function< void(ResultAPI const &result)> Auth::onAuthAdultConfirm
 성인 인증 팝업 결과 통지 더 자세히 ...
 

열거형 타입

enum class  LoginType { LoginType::GUEST , LoginType::ACCOUNT , LoginType::SELECT , LoginType::AUTO }
 HIVE 로그인 형태 정의 더 자세히 ...
 
enum class  AuthMaintenanceActionType { AuthMaintenanceActionType::OPEN_URL , AuthMaintenanceActionType::EXIT , AuthMaintenanceActionType::DONE }
 점검 화면에서 버튼을 눌렀을때 동작될 행동 더 자세히 ...
 

함수

static void Auth::initialize (onAuthInitialize listener)
 HIVE SDK 초기화 수행
만약 앱이 처음 실행된 경우라면 약관을 노출하고 동의를 받는 과정을 거치게 된다 더 자세히 ...
 
static LoginType Auth::getLoginType ()
 SDK 초기화 후 기존에 로그인한 정보에 따라서 수행할 수 있는 로그인 정보를 반환한다. 더 자세히 ...
 
static void Auth::login (LoginType loginType, onAuthLogin listener)
 주어진 로그인 타입에 따라서 HIVE 로그인을 요청한다. 더 자세히 ...
 
static void Auth::showLoginSelection (picojson::object currentData, picojson::object selectData, onAuthLogin listener)
 게스트 로그인 상태에서 HIVE 로그인을 수행하면 계정 충돌이 발생 할 수 있으며, 유저에게 HIVE 계정 전환을 요청 해야 한다. 더 자세히 ...
 
static void Auth::bindLogin (std::string selectedVid, onAuthLogin listener)
 유저가 충돌난 HIVE 계정 중 하나를 선택하면 HIVE 인증 서버에 결과를 전송해야 한다. 더 자세히 ...
 
static void Auth::logout (onAuthLogout listener)
 HIVE 로그인을 완료 하였으면 유저의 고유 ID 인 VID 와 세션키가 발급된 상태이다. 더 자세히 ...
 
static Account Auth::getAccount ()
 HIVE 유저의 인증 정보 반환한다 더 자세히 ...
 
static void Auth::showTerms (onAuthShowTerms listener)
 HIVE 약관 정보를 표시한다. 더 자세히 ...
 
static void Auth::checkMaintenance (bool isShow, onAuthMaintenance listener)
 점검 상태 표시 및 데이터 반환한다. 더 자세히 ...
 
static void Auth::showAdultConfirm (onAuthAdultConfirm listener)
 성인 인증을 요청한다. 더 자세히 ...
 
static void Auth::reset ()
 인증 정보를 포함하여 SDK 에서 사용하는 모든 데이터 초기화 한다. 더 자세히 ...
 
static void Auth::requestPermissionViewData (onAuthRequestPermissionViewData listener)
 권한고지 팝업을 구성하기 위한 데이터를 얻습니다. 더 자세히 ...
 

상세한 설명

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


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

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

타입정의 문서화

◆ onAuthAdultConfirm

typedef std::function<void(ResultAPI const & result)> Auth::onAuthAdultConfirm

성인 인증 팝업 결과 통지

매개변수
resultAPI 호출 결과

◆ onAuthInitialize

typedef std::function<void(ResultAPI const & result, AuthInitResult const & authInitResult)> Auth::onAuthInitialize

HIVE SDK 초기화 결과 통지

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

◆ onAuthLogin

typedef std::function<void(ResultAPI const & result, LoginType loginType, Account const & currentAccount, Account const & usedAccount)> Auth::onAuthLogin

HIVE 로그인 결과 통지

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

◆ onAuthLogout

typedef std::function<void(ResultAPI const & result)> Auth::onAuthLogout

HIVE 로그 아웃 결과 통지

매개변수
resultAPI 호출 결과

◆ onAuthMaintenance

typedef std::function<void(ResultAPI const & result, AuthMaintenanceInfo const & authMaintenanceInfo)> Auth::onAuthMaintenance

점검 팝업 결과 통지

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

◆ onAuthShowTerms

typedef std::function<void(ResultAPI const & result)> Auth::onAuthShowTerms

약관 정보 표시 결과 통지

매개변수
resultAPI 호출 결과

열거형 타입 문서화

◆ AuthMaintenanceActionType

enum class AuthMaintenanceActionType
strong

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

열거형 멤버
OPEN_URL 

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

EXIT 

앱 종료

DONE 

아무 처리도 하지 않음.

◆ LoginType

enum class LoginType
strong

HIVE 로그인 형태 정의

열거형 멤버
GUEST 

HIVE 게스트 로그인

ACCOUNT 

HIVE 로그인

SELECT 

계정 충돌로 인한 유저 선택이 필요한 경우

AUTO 

게스트 로그인이나 HIVE 로그인되어 있는 상태
(단말에 세션키가 남아 있는 상태)

함수 문서화

◆ bindLogin()

static void Auth::bindLogin ( std::string  selectedVid,
onAuthLogin  listener 
)
static

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


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

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

◆ checkMaintenance()

static void Auth::checkMaintenance ( bool  isShow,
onAuthMaintenance  listener 
)
static

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


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

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

◆ getAccount()

static Account Auth::getAccount ( )
static

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

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

◆ getLoginType()

static LoginType Auth::getLoginType ( )
static

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

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

◆ initialize()

static void Auth::initialize ( onAuthInitialize  listener)
static

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

매개변수
listenerAPI 호출 결과 통지

◆ login()

static void Auth::login ( LoginType  loginType,
onAuthLogin  listener 
)
static

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

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

◆ logout()

static void Auth::logout ( onAuthLogout  listener)
static

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


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

매개변수
listenerAPI 호출 결과 통지

◆ requestPermissionViewData()

static void Auth::requestPermissionViewData ( onAuthRequestPermissionViewData  listener)
static

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


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

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

◆ reset()

static void Auth::reset ( )
static

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


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

◆ showAdultConfirm()

static void Auth::showAdultConfirm ( onAuthAdultConfirm  listener)
static

성인 인증을 요청한다.


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

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

◆ showLoginSelection()

static void Auth::showLoginSelection ( picojson::object  currentData,
picojson::object  selectData,
onAuthLogin  listener 
)
static

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

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

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

◆ showTerms()

static void Auth::showTerms ( onAuthShowTerms  listener)
static

HIVE 약관 정보를 표시한다.


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

매개변수
listenerAPI 호출 결과 통지
Copyright © Com2uS Platform Corporation. All Right Reserved. 이용약관 개인정보 처리방침