HIVE SDK for iOS

Classes | Functions
Configuration

This class manage HIVE SDK configuration

More...

Classes

class  HIVEConfiguration
 This class manages HIVE SDK configuration. More...
 

Functions

typedef NS_ENUM (NSInteger, HIVEZoneType)
 HIVE Platform server zone type. More...
 
typedef NS_ENUM (NSInteger, HIVECustomUIType)
 HIVE Platform customUI type. More...
 
typedef NS_ENUM (NSInteger, HIVELanguage)
 HIVE Platform languages supported. More...
 
(NSString *) + HIVEConfiguration::getHiveSDKVersion
 Returns the version of HIVE SDK. More...
 
(NSString *) + HIVEConfiguration::getReferenceSDKVersion
 Returns the version of SDK referenced by HIVE SDK. More...
 
(NSString *) + HIVEConfiguration::getAppId
 Returns AppId (By default, AppId is set to the package name in the AndroidManifest.xml file. More...
 
(void) + HIVEConfiguration::setAppId:
 Set AppId (By default, AppId will be set to the package name in the AndroidManifest.xml file. More...
 
(HIVEZoneType) + HIVEConfiguration::getZone
 Returns HIVE platform server zone. More...
 
(void) + HIVEConfiguration::setZone:
 Sets HIVE platform server zone. More...
 
(NSString *) + HIVEConfiguration::getServerId
 Return serverId for server-specific maintenance popup support
(The world value registered in the back office world management) More...
 
(void) + HIVEConfiguration::setServerId:
 Sets serverId for server-specific maintenance popup support
(The world value registered in the back office world management should be inputted according to the server.) More...
 
(NSString *) + HIVEConfiguration::setGameLanguage:
 API to reflect language code used in game in module
Just type in two lowercase letters ("en"). More...
 
(BOOL) + HIVEConfiguration::getUseLog
 Returns whether HIVE SDK internal log is used. More...
 
(void) + HIVEConfiguration::setUseLog:
 Sets whether HIVE SDK internal log is used. More...
 
(NSInteger) + HIVEConfiguration::getHttpConnectTimeout
 Returns the default value of HTTP Connect Timeout (in seconds) More...
 
(NSInteger) + HIVEConfiguration::getHttpReadTimeout
 Returns the default value of HTTP Read Timeout (in seconds) More...
 
(void) + HIVEConfiguration::setHttpConnectTimeout:
 Sets the value of HTTP Connect Timeout (in seconds) More...
 
(void) + HIVEConfiguration::setHttpReadTimeout:
 Sets the value of HTTP Read Timeout (in seconds) More...
 
(NSInteger) + HIVEConfiguration::getMaxGameLogSize
 Returns maximum number of game logs. More...
 
(void) + HIVEConfiguration::setMaxGameLogSize:
 Sets maximum number of game logs (Note: No change unless special occasion) More...
 
(NSString *) + HIVEConfiguration::getMarket
 Returns market. More...
 
(void) + HIVEConfiguration::setMarket:
 Sets market. More...
 
(NSString *) + HIVEConfiguration::getChannel
 Returns channel. More...
 
(void) + HIVEConfiguration::setChannel:
 Set channel. More...
 
(NSDictionary *) + HIVEConfiguration::getUseCustomUI
 Returns whether HIVE SDK custom UI is used. More...
 
(void) + HIVEConfiguration::setCustomUI:
 Sets whether HIVE SDK custom UI is used. More...
 
(void) + HIVEConfiguration::setCompany:
 Sets company. More...
 
(void) + HIVEConfiguration::setCompanyIndex:
 Sets company index. More...
 
(NSString *) + HIVEConfiguration::getHiveCountry
 Returns country code from HIVE server. More...
 

Detailed Description

This class manage HIVE SDK configuration

Function Documentation

§ getAppId()

+ (NSString *) getAppId

Returns AppId (By default, AppId is set to the package name in the AndroidManifest.xml file.

AppId 반환 (AppId 는 기본적으로 AndroidManifest.xml 파일의 package 값으로 설정하게 된다.

However, it supports changes to API calls for reasons such as test setup.)

Returns
AppId

그러나 테스트 설정등의 이유로 API 호출에 대한 변경을 지원한다.)

Returns
AppId

§ getChannel()

+ (NSString *) getChannel

Returns channel.

채널 반환

Returns
Channel (HIVE: HIVE Platform)
채널 (C2S, LIN, KAK)

§ getHiveCountry()

+ (NSString *) getHiveCountry

Returns country code from HIVE server.

매번 현재 게임 언어의 설정 값을 기준으로 값을 얻어옴.

Returns
ISO

저장된 HIVE Country값을 리턴한다. (ISO 표준 국가코드)

Returns
nonnull NSString, 값이 없는 경우 (null 인 경우) 기기의 국가코드를 반환한다. 기기의 국가코드 값은 null일 수 있다.

§ getHiveSDKVersion()

+ (NSString *) getHiveSDKVersion

Returns the version of HIVE SDK.

Hive SDK 버전 반환

Returns
HIVE SDK version
Hive SDK 버전

§ getHttpConnectTimeout()

+ (NSInteger) getHttpConnectTimeout

Returns the default value of HTTP Connect Timeout (in seconds)

HTTP Timeout 의 기본 설정 값 반환 (초단위)

Returns
Default value of HTTP Connect Timeout (in seconds)
HTTP Timeout 의 기본 설정 값 (초단위)

§ getHttpReadTimeout()

+ (NSInteger) getHttpReadTimeout

Returns the default value of HTTP Read Timeout (in seconds)

Returns
Default value of HTTP Read Timeout (in seconds)

§ getMarket()

+ (NSString *) getMarket

Returns market.

결제 마켓 반환

Returns
Market (google, tstore, olleh, ozstore, googleplay_lebi)
결제 마켓 (google, tstore, olleh, ozstore, googleplay_lebi)

§ getMaxGameLogSize()

+ (NSInteger) getMaxGameLogSize

Returns maximum number of game logs.

게임 로그 최대 저장 갯수 반환

Returns
Maximum number of game logs
게임 로그 최대 저장 갯수

§ getReferenceSDKVersion()

+ (NSString *) getReferenceSDKVersion

Returns the version of SDK referenced by HIVE SDK.

Returns
The version of SDK referenced by HIVE SDK

§ getServerId()

+ (NSString *) getServerId

Return serverId for server-specific maintenance popup support
(The world value registered in the back office world management)

서버별 점검공지 팝업지원을 위한 serverId 반환 (백오피스 월드관리에 등록된 월드값을 서버에 따라 구분하여 입력이 되어야 한다.)

Returns
serverId Server ID for server-specific maintenance popup support
서버별 점검공지 팝업지원을 위한 serverId

§ getUseCustomUI()

+ (NSDictionary *) getUseCustomUI

Returns whether HIVE SDK custom UI is used.

Hive SDK custom UI 사용 여부 반환

Returns
Whether HIVE SDK custom UI is used
Hive SDK custom UI 사용 여부

§ getUseLog()

+ (BOOL) getUseLog

Returns whether HIVE SDK internal log is used.

Hive SDK 내부 로그 사용 여부 반환

Returns
Whether HIVE SDK internal log is used
Hive SDK 내부 로그 사용 여부

§ getZone()

+ (HIVEZoneType) getZone

Returns HIVE platform server zone.

Hive 플랫폼 서버 존 반환

Returns
HIVE platform server zone (sandbox: for development, real: for production)
Hive SDK 플랫폼 서버 존 (sandbox : 개발용, real : 실계용)

§ NS_ENUM() [1/3]

typedef NS_ENUM ( NSInteger  ,
HIVEZoneType   
)

HIVE Platform server zone type.

Author
seongjunkim

< HIVE Platform internal test server

< HIVE Platform external test server

< HIVE Platform common server

< TODO:

§ NS_ENUM() [2/3]

typedef NS_ENUM ( NSInteger  ,
HIVECustomUIType   
)

HIVE Platform customUI type.

Author
imsunghoon

< SignIn custom UI

< Connect custom UI

< Achievement custom UI

< SyncAccount customUI

§ NS_ENUM() [3/3]

typedef NS_ENUM ( NSInteger  ,
HIVELanguage   
)

HIVE Platform languages supported.

Author
seokjinyong

§ setAppId:()

+ (void) setAppId: (NSString*)  appId

Set AppId (By default, AppId will be set to the package name in the AndroidManifest.xml file.

AppId 설정 (AppId 는 기본적으로 AndroidManifest.xml 파일의 package 값으로 설정하게 된다.

However, it supports changes to API calls for reasons such as test setup.)

Parameters
appIdAppId

그러나 테스트 설정등의 이유로 API 호출에 대한 변경을 지원한다.)

Parameters
appIdAppId

§ setChannel:()

+ (void) setChannel: (NSString*)  channel

Set channel.

채널 설정

Parameters
Channel(HIVE: HIVE Platform)
채널(C2S, LIN, KAK)

§ setCompany:()

+ (void) setCompany: (NSString*)  company

Sets company.

회사 설정

Parameters
Company(COM2US: Com2us, GAMEVIL: Gamevil)
Returns
회사 (COM2US, GAMEVIL, ...)

§ setCompanyIndex:()

+ (void) setCompanyIndex: (NSInteger)  companyIndex

Sets company index.

회사 인덱스 설정

Parameters
CompanyIndex(COM2US: 1, GAMEVIL: 2...)
Returns
회사 인덱스 (COM2US = 1,GAMEVIL = 2, ...)

§ setCustomUI:()

+ (void) setCustomUI: (NSDictionary *)  useCustomUI

Sets whether HIVE SDK custom UI is used.

Parameters
useCustomUIWhether HIVE SDK custom UI is used

§ setGameLanguage:()

+ (NSString *) setGameLanguage: (NSString*)  gameLanguage

API to reflect language code used in game in module
Just type in two lowercase letters ("en").

현재 게임 언어을 하이브 플랫폼에 알려주는 API

ISO 639-1 format.

Internally, uppercase characters are converted to lowercase characters. Alphabetic case rules follow US rules.

Parameters
languageLanguage code used in game.
Parameters
gameLanugageISO 639 alpha-2 형태의 설정하고자 하는 언어 코드
Returns
gameLanguage에 매칭되는 하이브가 지원하는 language code string (ISO 639 alpha-2)

gameLanguage 값을 가지고 하이브에서 지원하는 언어로 매핑하여, 그 값을 돌려준다.

리턴 값은 nil 일 수 없다. 예외 상황이 발생할 경우 기본언어("en")를 리턴한다. redmine.com2us.com/issues/6132#note-10

§ setHttpConnectTimeout:()

+ (void) setHttpConnectTimeout: (NSInteger)  httpTimeout

Sets the value of HTTP Connect Timeout (in seconds)

HTTP Timeout 의 기본 설정 값 설정 (초단위)

Parameters
Valueof HTTP Connect Timeout (in seconds)
httpTimeoutHTTP Timeout 의 기본 설정 값 (초단위)

§ setHttpReadTimeout:()

+ (void) setHttpReadTimeout: (NSInteger)  httpTimeout

Sets the value of HTTP Read Timeout (in seconds)

Parameters
Valueof HTTP Read Timeout (in seconds)

§ setMarket:()

+ (void) setMarket: (NSString*)  market

Sets market.

결제 마켓 설정

Parameters
marketMarket (google, tstore, olleh, ozstore, googleplay_lebi)
market결제 마켓 (google, tstore, olleh, ozstore, googleplay_lebi)

§ setMaxGameLogSize:()

+ (void) setMaxGameLogSize: (NSInteger)  maxGameLogSize

Sets maximum number of game logs (Note: No change unless special occasion)

게임 로그 최대 저장 갯수 설정 (특별한 경우가 아니면 변경 금지)

Parameters
maxGameLogSizeMaximum number of game logs
maxGameLogSize게임 로그 최대 저장 갯수

§ setServerId:()

+ (void) setServerId: (NSString*)  serverId

Sets serverId for server-specific maintenance popup support
(The world value registered in the back office world management should be inputted according to the server.)

서버별 점검공지 팝업지원을 위한 serverId 설정 (백오피스 월드관리에 등록된 월드값을 서버에 따라 구분하여 입력이 되어야 한다.)

Parameters
serverIdfor server-specific maintenance popup support
서버별점검공지 팝업지원을 위한 serverId

§ setUseLog:()

+ (void) setUseLog: (BOOL)  useLog

Sets whether HIVE SDK internal log is used.

Hive SDK 내부 로그 사용 여부 설정

Parameters
useLogWhether HIVE SDK internal log is used
useLogHive SDK 내부 로그 사용 여부

§ setZone:()

+ (void) setZone: (HIVEZoneType)  zone

Sets HIVE platform server zone.

Parameters
zoneHIVE platform server zone (sandbox: for development, real: for production)
Copyright © GAMEVIL COM2US PLATFORM Inc. All Right Reserved. Terms of Use Privacy Policy