HIVE SDK for C++

Classes | Typedefs | Enumerations | Functions
Configuration

This class manage HIVE SDK configuration

More...

Classes

class  Configuration
 This class manage HIVE SDK configuration

More...
 

Typedefs

typedef std::function< void(ResultAPI const &result, std::string value)> Configuration::onGetMetaData
 MetaData request result callback
More...
 

Enumerations

enum class  ZoneType { ZoneType::SANDBOX , ZoneType::TEST , ZoneType::REAL , ZoneType::DEV }
 Hive Platform server zone type. More...
 
enum class  HIVELanguage
 HIVE Platform languages supported. More...
 
enum class  HiveThemeType
 Hive theme. More...
 

Functions

static std::string Configuration::getHiveSDKVersion ()
 Returns HIVE SDK Version. More...
 
static std::string Configuration::getReferenceSDKVersion ()
 Return version of SDK referenced by HIVE SDK. More...
 
static std::string Configuration::getAppId ()
 Returns AppId (By default, AppId will be set to the package name in the AndroidManifest.xml file. More...
 
static void Configuration::setAppId (std::string appId)
 Set AppId (By default, AppId will be set to the package name in the AndroidManifest.xml file. More...
 
static ZoneType Configuration::getZone ()
 Returns Hive platform server zone. More...
 
static void Configuration::setZone (ZoneType zone)
 Set Hive Hive platform server zone. More...
 
static std::string Configuration::getServerId ()
 Return serverId for server-specific maintenance popup support
(The world value registered in the back office world management) More...
 
static void Configuration::setServerId (std::string serverId)
 Set 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...
 
static void Configuration::updateServerId (std::string serverId)
 Set 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...
 
static void Configuration::setGameLanguage (std::string language)
 API to reflect language code used in game in module
Just type in two lowercase letters ("en"). More...
 
static void Configuration::updateGameLanguage (std::string language)
 API to reflect language code used in game in module
Just type in two lowercase letters ("en"). More...
 
static bool Configuration::getUseLog ()
 Returns whether HIVE SDK internal log is used. More...
 
static void Configuration::setUseLog (bool useLog)
 Set whether HIVE SDK internal log is used. More...
 
static void Configuration::setCompany (std::string company)
 Set company. More...
 
static void Configuration::setCompanyIndex (int companyIndex)
 Set company. More...
 
static std::string Configuration::getChannel ()
 Returns channel. More...
 
static void Configuration::setChannel (std::string channel)
 Set channel. More...
 
static int Configuration::getHttpConnectTimeout ()
 Returns the default value of HTTP Connect Timeout (in seconds) More...
 
static void Configuration::setHttpConnectTimeout (int httpConnectTimeout)
 Set the value of HTTP Connect Timeout (in seconds) More...
 
static int Configuration::getHttpReadTimeout ()
 Returns the default value of HTTP Read Timeout (in seconds) More...
 
static void Configuration::setHttpReadTimeout (int httpReadTimeout)
 Set the value of HTTP Read Timeout (in seconds) More...
 
static int Configuration::getMaxGameLogSize ()
 Returns maximum number of game logs. More...
 
static void Configuration::setMaxGameLogSize (int maxGameLogSize)
 Set maximum number of game logs (Note: No change unless special occasion) More...
 
static std::string Configuration::getMarket ()
 Return market. More...
 
static void Configuration::setMarket (std::string market)
 Set market. More...
 
static std::string Configuration::getHiveCountry ()
 HIVE 서버에서 판단한 국가코드를 반환한다. More...
 
static std::string Configuration::getHiveTimeZone ()
 HIVE 서버에서 판단한 TimeZone 정보를 반환한다. More...
 
static unsigned int Configuration::getAnalyticsSendLimit ()
 전송 주기마다 전송할 로그의 최대치. More...
 
static void Configuration::setAnalyticsSendLimit (unsigned int limit)
 전송 주기마다 전송할 로그의 최대치 설정. More...
 
static unsigned int Configuration::getAnalyticsQueueLimit ()
 최대로 쌓을수 있는 로그의 양. More...
 
static void Configuration::setAnalyticsQueueLimit (unsigned int limit)
 최대로 쌓을 수 있는 로그의 수 More...
 
static float Configuration::getAnalyticsSendCycleSeconds ()
 로그 전송 주기. More...
 
static void Configuration::setAnalyticsSendCycleSeconds (float seconds)
 로그 전송 주기 설정. More...
 

Detailed Description

This class manage HIVE SDK configuration

Typedef Documentation

◆ onGetMetaData

typedef std::function<void(ResultAPI const & result,std::string value)> Configuration::onGetMetaData

MetaData request result callback

Parameters
resultResult of API call
valueThe metadata value that matches the key
See also
#getMetaData(String, ConfigurationGetMetaDataListener)

Enumeration Type Documentation

◆ HIVELanguage

enum class HIVELanguage
strong

HIVE Platform languages supported.

Author
seokjinyong

◆ HiveThemeType

enum class HiveThemeType
strong

Hive theme.

Author
daunjoung

◆ ZoneType

enum class ZoneType
strong

Hive Platform server zone type.

Author
seongjunkim
Enumerator
SANDBOX 

Hive 플랫폼 서버 외부 개발

TEST 

Hive 플랫폼 서버 내부 개발

REAL 

Hive 플랫폼 서버 실서비스

DEV 

Hive 플랫폼 서버 내부 개발

Function Documentation

◆ getAnalyticsQueueLimit()

static unsigned int Configuration::getAnalyticsQueueLimit ( )
static

최대로 쌓을수 있는 로그의 양.

Returns
unsigned int 최대로 쌓을수 있는 로그의 양.

◆ getAnalyticsSendCycleSeconds()

static float Configuration::getAnalyticsSendCycleSeconds ( )
static

로그 전송 주기.

Returns
float 전송주기

◆ getAnalyticsSendLimit()

static unsigned int Configuration::getAnalyticsSendLimit ( )
static

전송 주기마다 전송할 로그의 최대치.

Returns
unsigned int 전송 주기마다 전송할 로그의 최대치.

◆ getAppId()

static std::string Configuration::getAppId ( )
static

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

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

Returns
AppId

◆ getChannel()

static std::string Configuration::getChannel ( )
static

Returns channel.

Returns
Channel (HIVE : HIVE Platform)

◆ getHiveCountry()

static std::string Configuration::getHiveCountry ( )
static

HIVE 서버에서 판단한 국가코드를 반환한다.

Returns
ISO

◆ getHiveSDKVersion()

static std::string Configuration::getHiveSDKVersion ( )
static

Returns HIVE SDK Version.

Returns
HIVE SDK version

◆ getHiveTimeZone()

static std::string Configuration::getHiveTimeZone ( )
static

HIVE 서버에서 판단한 TimeZone 정보를 반환한다.

Returns
JSON String

◆ getHttpConnectTimeout()

static int Configuration::getHttpConnectTimeout ( )
static

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

Returns
Default value of HTTP Connect Timeout (in seconds)

◆ getHttpReadTimeout()

static int Configuration::getHttpReadTimeout ( )
static

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

Returns
Default value of HTTP Read Timeout (in seconds)

◆ getMarket()

static std::string Configuration::getMarket ( )
static

Return market.

Returns
Market (google, tstore, olleh, ozstore, googleplay_lebi)

◆ getMaxGameLogSize()

static int Configuration::getMaxGameLogSize ( )
static

Returns maximum number of game logs.

Returns
Maximum number of game logs

◆ getReferenceSDKVersion()

static std::string Configuration::getReferenceSDKVersion ( )
static

Return version of SDK referenced by HIVE SDK.

Returns
Version of SDK referenced by HIVE SDK

◆ getServerId()

static std::string Configuration::getServerId ( )
static

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

Returns
serverId Server ID for server-specific maintenance popup support

◆ getUseLog()

static bool Configuration::getUseLog ( )
static

Returns whether HIVE SDK internal log is used.

Returns
Whether HIVE SDK internal log is used

◆ getZone()

static ZoneType Configuration::getZone ( )
static

Returns Hive platform server zone.

Returns
Hive platform server zone (sandbox : for development, real : for production)

◆ setAnalyticsQueueLimit()

static void Configuration::setAnalyticsQueueLimit ( unsigned int  limit)
static

최대로 쌓을 수 있는 로그의 수

Parameters
limit최대 대기 가능한 로그의 수

◆ setAnalyticsSendCycleSeconds()

static void Configuration::setAnalyticsSendCycleSeconds ( float  seconds)
static

로그 전송 주기 설정.

Parameters
seconds전송 주기 (초)

◆ setAnalyticsSendLimit()

static void Configuration::setAnalyticsSendLimit ( unsigned int  limit)
static

전송 주기마다 전송할 로그의 최대치 설정.

Parameters
limit전송주기마다 전송할 최대 로그의 양

◆ setAppId()

static void Configuration::setAppId ( std::string  appId)
static

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

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

Parameters
appIdAppId

◆ setChannel()

static void Configuration::setChannel ( std::string  channel)
static

Set channel.

Parameters
Channel(HIVE : HIVE Platform)

◆ setCompany()

static void Configuration::setCompany ( std::string  company)
static

Set company.

Parameters
Company(COM2US : Com2us, GAMEVIL : Gamevil)

◆ setCompanyIndex()

static void Configuration::setCompanyIndex ( int  companyIndex)
static

Set company.

Parameters
CompanyIndex(1 : Com2us, 2 : Gamevil)

◆ setGameLanguage()

static void Configuration::setGameLanguage ( std::string  language)
static

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

ISO 639-1 format.

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

Parameters
languageLanguage code used in game.

◆ setHttpConnectTimeout()

static void Configuration::setHttpConnectTimeout ( int  httpConnectTimeout)
static

Set the value of HTTP Connect Timeout (in seconds)

Parameters
Valueof HTTP Connect Timeout (in seconds)

◆ setHttpReadTimeout()

static void Configuration::setHttpReadTimeout ( int  httpReadTimeout)
static

Set the value of HTTP Read Timeout (in seconds)

Parameters
Valueof HTTP Read Timeout (in seconds)

◆ setMarket()

static void Configuration::setMarket ( std::string  market)
static

Set market.

Parameters
marketMarket (google, tstore, olleh, ozstore, googleplay_lebi)

◆ setMaxGameLogSize()

static void Configuration::setMaxGameLogSize ( int  maxGameLogSize)
static

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

Parameters
maxGameLogSizeMaximum number of game logs

◆ setServerId()

static void Configuration::setServerId ( std::string  serverId)
static

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

Parameters
serverIdfor server-specific maintenance popup support

◆ setUseLog()

static void Configuration::setUseLog ( bool  useLog)
static

Set whether HIVE SDK internal log is used.

Parameters
useLogWhether HIVE SDK internal log is used

◆ setZone()

static void Configuration::setZone ( ZoneType  zone)
static

Set Hive Hive platform server zone.

Parameters
zoneHive platform server zone (sandbox : for development, real : for production)

◆ updateGameLanguage()

static void Configuration::updateGameLanguage ( std::string  language)
static

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

ISO 639-1 format.

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

Parameters
languageLanguage code used in game.

◆ updateServerId()

static void Configuration::updateServerId ( std::string  serverId)
static

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

Parameters
serverIdfor server-specific maintenance popup support
Copyright © Com2uS Platform Corporation. All Right Reserved. Terms of Use Privacy Policy