Active User 모듈 레퍼런스 가이드

상수 및 자료형

USER_AGREE_RESULT

* 유저 동의 결과를 받는 콜백 함수에서 사용되는 데이터

typedef enum USER_AGREE_RESULT_TYPE
{
USER_AGREE_SUCCESS = 0,
USER_AGREE_TERMS_CLOSE = 1 // only iOS
}USER_AGREE_RESULT;

ACTIVE_USER_RESULT

* DID 요청 결과를 받는 콜백 함수에서 사용되는 데이터

typedef enum ACTIVE_USER_RESULT_TYPE
{
ACTIVE_USER_GETDID_SUCCESS = 0,
ACTIVE_USER_GETDID_FAIL = 1,
}ACTIVE_USER_RESULT;

SERVER_STATE

* 모듈 서버를 설정 (Available in 2.6.0 and later)

typedef enum SERVER_STATE_TYPE
{
LIVE_SERVER = 0,
STAGING_SERVER = 1,
SANDBOX_SERVER = 2
}SERVER_STATE;

SHOW_POPUP

* 점검,공지 팝업을 보여줘야 할지 여부를 나타내는 데이터 (Available in 2.6.5 and later)

typedef enum SHOW_POPUP_TYPE
{
SHOW = 0,
NOTSHOW = 1
} SHOW_POPUP;

POPUP_STATE_TYPE

* 점검,공지 팝업이 닫혔는지 상태를 나태내는 데이터 (Available in 2.6.6 and later)

typedef enum POPUP_STATE_TYPE
{
CLOSE = 0
} POPUP_STATE;

REQUEST_PERMISSION_STATE_TYPE

* (Android Only)Android 권한 추가 요청 시 요청에 대한 결과 상태를 나타내는 데이터 (Available in 2.9.0 and later)

typedef enum REQUEST_PERMISSION_STATE_TYPE
{
SUCCESS = 0,
ERROR = -1,
NOT_SUPPORT_OS_VERSION = -2,
WRONG_TYPE_DATA = -3
} REQUEST_PERMISSION_STATE;

함수

void CS_ActiveUserStart()

Description
ActiveUser의 모듈을 시작합니다. (앱의 초기화시에 호출) 조건에 따라 이 시점에 약관 동의가 뜨며, 시작시 매번 호출해야 합니다. DownloadCheck, UserAgree 정보를 서버로 전송합니다.
기본값으로 LIVE 서버로 세팅 됩니다.
Return Value

void

Remark
Java / C# : start()

void CS_ActiveUserStartEx(SERVER_STATE serverState)

Description
ActiveUser의 모듈을 시작합니다. (앱의 초기화시에 호출) 조건에 따라 이 시점에 약관 동의가 뜨며, 시작시 매번 호출해야 합니다. DownloadCheck, UserAgree 정보를 서버로 전송합니다.
serverState에 따라 모듈이 사용하는 서버가 달라집니다. 관련 내용은 링크를 참고해주세요.
Return Value

void

Parameter

in/out	Type	Name	Description
in	SERVER_STATE	serverState	설정할 모듈 서버 enum 값

Remark
Java / C# : start(SERVER_STATE server)
Available in 2.6.0 and later

void CS_ActiveUserStartWithoutNotice(SERVER_STATE serverState, int showNotice)

Description
ActiveUser의 모듈을 시작합니다. (앱의 초기화시에 호출) 조건에 따라 이 시점에 약관 동의가 뜨며, 시작시 매번 호출해야 합니다. DownloadCheck, UserAgree 정보를 서버로 전송합니다.
serverState에 따라 모듈이 사용하는 서버가 달라집니다. 관련 내용은 링크를 참고해주세요.
showNoticePopup이 true인 경우 기존에 존재하던 CS_ActiveUserStartEx 함수와 동일하게 작동합니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	SERVER_STATE	serverState	부가 설명 없음
in	int	showNotice	초기화시에 점검, 업데이트 팝업 노출을 진행할지 선택하는 값

Remark
JAVA/C# : start(SERVER_STATE server, bool showNotice)
Available in 2.6.5 and later

void CS_ActiveUserSetServerId(const char* server_id)

Description
모듈의 통합식별자 Server ID를 설정합니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	const char*	server_id	설정 할 Server ID

Remark
not comment

void CS_ActiveUserSetGameLanguage(const char* game_language)

Description
모듈의 통합식별자 Game Language(게임 언어)를 설정합니다. (게임 언어 지원 코드)

게임 언어를 설정하지 않을 경우 단말 언어 설정을 따릅니다.

(CS_ActiveUserStart() 혹은 CS_ActiveUserStartEx() 수행후 호출하여 설정, 또한 게임 언어 변경이 필요한 경우 호출하여 설정)

added in 2.7.3(iOS), 2.7.5(AD)

Return Value

void

Parameter

in/out	Type	Name	Description
in	const char*	game_language	game_language 코드 값

Remark
Java / C# : setGameLanguage()

Available in 2.7.3(iOS), 2.7.5(Android) and later

void CS_SetMinTimeoutSeconds(int seconds)

Description
웹뷰 타임아웃 초기 시간을 설정합니다.

설정하지 않을 경우 웹뷰 타임아웃 대기 시간은 최초 5초(초기 시간)이며 타임아웃이 발생할 경우 5초씩 증가하여 5 / 10 / 15초의 타임아웃 대기시간을 갖습니다.

타임아웃 초기 시간은 5~15초 사이로 설정 가능합니다. 해당 범위에서 벗어난 값을 사용할 경우 기본 5초로 설정됩니다.

예) 초기 시간 7초 설정시 : 7 / 10 / 15초 타임아웃 대기시간, 초기 시간 12초 설정시 : 12 / 15 / 15초 타임아웃 대기 시간

added in 2.8.0(iOS), 2.8.0(AD)

Return Value

void

Parameter

in/out	Type	Name	Description
in	int	seconds	타임아웃 초기 시간 값

Remark
Java / C# : setNetworkTimeSeconds()

Available in 2.8.0(iOS), 2.8.0(Android) and later

int CS_ActiveUserGetVersion(char* buf, int bufSize)

Description
모듈의 버전 확인하는 함수.
Return Value

CM_E_SUCCESS : 성공
CM_E_ERROR :기타에러
CM_E_SHORTBUF : 버퍼가 작음

Parameter

in/out	Type	Name	Description
out	char*	buf	버전 정보를 받아오는 메모리 버퍼. 종료 문자를 더하여서 최소 9byte가 필요함.
in	int	bufSize	메모리 버퍼의 크기. byte 단위.

Remark
Java / C# : getVersion()

int CS_ActiveUserSetLogged(int isLogged)

Description
로그를 노출할지 설정. (Android Only)
Return Value

Parameter

in/out	Type	Name	Description
in	int	isLogged	로그를 노출할지 여부

Remark
Java / C# : setLogged(int isLogged)

const char* CS_ActiveUserGetDID()

Description
ActiveUser로 부터 DID의 값을 전달 받습니다. ACTIVE_USER_GETDID_SUCCESS 콜백 이후 받을 수 있습니다. (혹은 콜백 내에서 세팅)
Return Value

DID string

Remark
Java / C# : getDID()

Available in 2.0.0 and later

void CS_ActiveUserSetCallback(ActiveUserCB cb)

Description
ActiveUser의 콜백 함수를 등록합니다. CS_ActiveUserStart 호출 이전에 콜백을 등록해야 합니다. 약관동의 창이 닫히고 서버로 부터 DID 를 받아 온 후 호출 됩니다. UserAgreeCallback 이후 불리게 됩니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	ActiveUserCB	cb	콜백 함수 typedef void (*ActiveUserCB)(ACTIVE_USER_RESULT result);

Remark

void CS_UserAgreeSetCallback(UserAgreeCB cb)

Description
UserAgree의 콜백 함수를 등록합니다. CS_ActiveUserStart 호출 이전에 콜백을 등록해야 합니다. 약관동의 창이 닫히고 호출 됩니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	UserAgreeCB	cb	콜백 함수 typedef void (*UserAgreeCB)(USER_AGREE_RESULT result);

Remark
Java / C# : setUserAgreeNotifier(UserAgreeNotifier notifier)

void CS_UserAgreeShowTermsUI(void* parentView)

Description
이용 약관을 다시 보여줍니다. (유저가 다시 보기 등을 눌렀을 때 사용) 약관 동의 창과는 다릅니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	void*	parentView	해당 게임의 viewController의 view를 전달한다. (iOS에서 사용되는 파라미터)

Remark
Java / C# : showUserAgreeTerms()

void CS_UserAgreeShowTermsUIEx(void* parentView, const char* url)

Description
이용 약관 다시 보기 창이지만, 입력해준 Url 로 웹뷰를 호출합니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	void*	parentView	해당 게임의 viewController의 view를 전달한다. (iOS에서 사용되는 파라미터)
in	const char*	url	게임이 퍼블리싱이나 기타 이유로 외부 이용약관이나 공통 이용약관과 다른경우 변경된 페이지의 URL을 노출 시킵니다.

Remark
Java / C# : showUserAgreeTerms()

void CS_UserAgreeReset()

Description
사용자동의화면이 재노출이 가능하도록 설정함. 아래의 특정 경우가 아니면 사용하면 안됩니다.
카톡게임의 경우 로그아웃이 된 이후 재로그인할때 약관동의화면이 노출되도록 가이드됨에 따라 추가됨.
Reset후에도 CS_ActiveUserStart가 호출되어야 합니다.
Return Value

void

Remark
java / C# : resetUserAgree()

void CS_ActiveUserSetEnableRequestStoragePermission()

Description
Android 6.0 이상에서 Storage 퍼미션 권한을 요청 합니다. (Only Android)
기본적으로 Phone 퍼미션 권한은 요청하며, 호출 시 Storage 퍼미션 권한도 요청하게 됩니다.
CS_ActiveUserStart() 이전에 세팅해 주어야 합니다.
Return Value

void

Remark
java / C# : setEnableRequestStoragePermission()
Available in 2.6.2 and later

void CS_UpdateNoticeShowPopup(UpdateNoticePopupCB cb)

Description
점검공지, 업데이트 팝업 UI를 노출합니다.
cb설정을 하지 않는 경우(혹은 null로 설정하는 경우) 정상작동하지 않을 수 있습니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	UpdateNoticePopupCB	cb	팝업이 닫히는 경우 호출되는 콜백

Remark
Available in 2.0.0 and later
Java / C# : showNoticePopup(final NoticeShowPopupCBWithData nspCallBack)

void CS_UpdateNoticeGetPopupInfo(UpdateNoticeInfoCB cb)

Description
점검공지, 업데이트 팝업 구성에 필요한 데이터를 UpdateNoticeInfoCB 콜백으로 전달합니다
cb설정을 하지 않는 경우(혹은 null로 설정하는 경우) 정상작동하지 않을 수 있습니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	UpdateNoticeInfoCB	cb	팝업 데이터를 전달받는 콜백

Remark
Available in 2.6.6 and later
Java / C# : getNoticePopupInfo(final NoticePopupInfoCBWithData npCallBack)

void CS_ActiveUserGetPermissionViewData(PermissionViewDataCB cb)

Description
권한고지 팝업 구성에 필요한 데이터를 PermissionViewDataCB 콜백으로 전달합니다
cb설정을 하지 않는 경우(혹은 null로 설정하는 경우) 정상작동하지 않을 수 있습니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	PermissionViewDataCB	cb	팝업 데이터를 전달받는 콜백

Remark
Available in 2.8.8 and later
Java / C# :

void CS_ActiveUserSetPermissionViewState(int isOn)

Description
앱 설치 후 초기화 시 모듈이 노출시키는 권한 고지 페이지를 노출시킬지 여부를 제어합니다.
최초 앱 설치 후 해당 API를 false(0)로 호출하고 초기화(start API)를 호출할 경우 모듈의 권한 고지 페이지가 노출되지 않습니다. 단, 이후 해당 API를 true(1)로 호출하고 초기화(start API)를 호출할 경우 모듈의 권한 고지 페이지가 노출됩니다.
이미 모듈의 권한 고지 페이지를 보았던 경우에는 해당 API가 영향을 주지 않습니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	int	isOn	true(default) : 권한 고지 노출 / false : 권한 고지 미노출

Remark
Available in 2.9.0 and later
Java / C# : setIsShowPermissionView(boolean isShow) / setPermissionViewState(int isOn)

void CS_ActiveUserSendFunnelsLogs(String funnelsTrack, String optionTag)

Description
일부 퍼널 로그를 전송할 수 있는 기능을 제공합니다.
퍼널 로그를 전송하여 애널리틱스 콘솔을 통해 해당 시점이 정상적으로 진행되었는지 확인할 수 있습니다. 기본적인 모듈 기능(약관 노출 시점, 서버 공지 팝업 노출 시점 등)의 퍼널 로그는 모듈 내부에 내장되어 있습니다.
funnelsTrack 파라미터에는 "700"(String, 앱의 추가 다운로드 시작 시점을 퍼널 로그로 전송), "800"(String, 앱의 추가 다운로드 완료 시점을 퍼널 로그로 전송) 을 선택하여 입력합니다.
optionTag에는 부가적으로 넣을 정보를 입력합니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	String	funnelsTrack	"700" 혹은 "800" 사용 가능
in	String	optionTag	부가 정보 입력

Remark
Available in 2.9.0 and later
Java / C# : sendFunnelsLogs(String funnelsTrack, String optionTag) / sendFunnelsLogs(string funnelsTrack, string optionTag)

void CS_ActiveUserRequestUserPermissions(String requests, RequestUserPermissionsCB cb)

Description
(Android Only) Android 의 Dangerous 권한을 추가로 요청합니다.
주의! 해당 API로 추가적으로 권한을 요청하는 권한은 꼭 AndroidManifest.xml에 그 권한이 선언되어 있어야 합니다.
ActiveUser 모듈 초기화 시점에 받지 않는 별도의 권한(앱에서 사용하는 별도의 권한)을 원하는 시점에 요청하여 사용자에게 허용 혹은 거부 여부를 받습니다.
사용자가 요청된 권한에 대해서 허용 혹은 거부를 모두 한 뒤엔 결과 정보가 콜백으로 전달됩니다.
Return Value

void

Parameter

in/out	Type	Name	Description
in	String	requests	Android 권한을 JsonArray 형태로 구성합니다. 그리고 구성된 JsonArray 형태를 String 형태로 파라미터에 입력합니다. (ex : String requests = "{"requests":["android.permission.READ_CONTACTS","android.permission.READ_PHONE_STATE","android.permission.WRITE_EXTERNAL_STORAGE"]}";)
in	RequestUserPermissionsCB	cb	권한 고지 요청 결과를 전달받는 콜백

Remark
Available in 2.9.0 and later
Java / C# : requestUserPermissions(final String requests, final RequestPermissionCBWithData rpCallBack) / CS_ActiveUserRequestUserPermissions(const char* requests, RequestUserPermissionsCB cb)

Java / C# only

ActiveUser(Activity activity)

Description
ActiveUser 객체 생성자
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	Activity	activity	Activity

Remark
not comment

void onActivityStarted()

Description
Activity LifeCycle 에서 onStart 에 해당하는 시점에 호출해 주면 됩니다. (다른 게임엔진의 경우 resume 등의 시점)
Return Value

void

Remark
not comment

void onActivityStopped()

Description
Activity LifeCycle 에서 onStop 에 해당하는 시점에 호출해 주면 됩니다. (다른 게임엔진의 경우 pause 등의 시점)
Return Value

void

Remark
not comment

콜백 함수

typedef void (* UserAgreeCB)(USER_AGREE_RESULT result)

Description
유저 동의 또는 개인정보 수집 동의를 확인한경우, 혹은 이미 동의를 한 경우 호출된다. 앱 런치 이후 동의 화면에서 확인 버튼을 누른 다음 실행 될 프로세스를 콜백 이후에 구현 하면 됩니다.
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	USER_AGREE_RESULT	result	USER_AGREE_RESULT 입니다.

Remark
not comment
Sample Code

void UserAgreeCallBack(USER_AGREE_RESULT type)
{
switch (type) {
case USER_AGREE_SUCCESS:
NSLog(@"USER_AGREE_SUCCESS");
break;
default:
break;
}
}

typedef void (* ActiveUserCB)(ACTIVE_USER_RESULT result)

Description
USER_AGREE_RESULT 이후, DID의 값을 서버에서 전송받거나(최초 설치) 앱 내부에서 정상적으로 로딩된 경우 호출 되는 콜백 함수이다.
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	ACTIVE_USER_RESULT	result	ACTIVE_USER_RESULT 입니다.

Remark
not comment
Sample Code

void ActiveUserCallBack(ACTIVE_USER_RESULT type)
{
switch (type) {
case ACTIVE_USER_GETDID_SUCCESS:
NSLog(@"ACTIVE_USER_GETDID_SUCCESS");
NSLog(@"%s", CS_ActiveUserGetDID());
break;
case ACTIVE_USER_GETDID_FAIL:
NSLog(@"ACTIVE_USER_GETDID_FAIL");
break;
default:
break;
}
}

typedef void (* UpdateNoticePopupCB)(POPUP_STATE state)

Description
iOS에서 CS_UpdateNoticeShowPopup 호출시 등장하는 팝업이 닫히는 경우 호출
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	POPUP_STATE	state	팝업의 상태

Remark
not comment
Sample Code

void UpdateNoticePopupCallback(POPUP_STATE state)
{
switch (state) {
case CLOSE:
NSLog(@"Popup Close");
break;
default:
break;
}
}

typedef void (* UpdateNoticeInfoCB)(SHOW_POPUP show, const char* jsonData)

Description
iOS에서 CS_UpdateNoticeGetPopupInfo 함수 호출시 결과를 전달받는 콜백
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	SHOW_POPUP	show	노출해야 할 팝업이 존재하는지 여부
in	const char*	jsonData	팝업 데이터

Remark
not comment
Sample Code

void UpdateNoticeInfoCallback(SHOW_POPUP show, const char* jsonData)
{
switch (show) {
case SHOW:
NSLog(@"Show Popup");
break;
case NOTSHOW:
NSLog(@"Not show Popup");
break;
default:
break;
}
}

typedef void (* PermissionViewDataCB)(const char* jsonData)

Description
iOS에서 CS_ActiveUserGetPermissionViewData 함수 호출시 결과를 전달받는 콜백
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	const char*	jsonData	팝업 데이터

Remark
not comment
Sample Code

void PermissionViewDataCallBack(const char* jsonData)
{
if (jsonData != null) {
// 가이드 참고
}
}

typedef void (* RequestUserPermissionsCB)(REQUEST_PERMISSION_STATE state, const char* grantedPermissions, const char* deniedPermissions)

Description
Android에서 CS_ActiveUserRequestUserPermissions 함수 호출시 결과를 전달받는 콜백
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	REQUEST_PERMISSION_STATE	state	Android 추가 권한 요청 결과 상태
in	const char*	grantedPermissions	허용한 권한 목록
in	const char*	deniedPermissions	거부한 권한 목록

Remark
not comment
Sample Code

void PermissionViewDataCallBack(REQUEST_PERMISSION_STATE state, const char* grantedPermissions, const char* deniedPermissions)
{
switch(state) {
case SUCCESS:
if (grantedPermissions != null) {
// 허용된 권한 목록 확인 가능
}
if (deniedPermissions != null) {
// 거부된 권한 목록 확인 가능
}
break;
}
}

void noticeShowPopupCBWithData(POPUP_STATE state)

Description
Java에서 CS_UpdateNoticeShowPopup 호출시 등장하는 팝업이 닫히는 경우 호출
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	POPUP_STATE	state	팝업의 상태

Remark
not comment
Sample Code

@Override
public void noticeShowPopupCBWithData(final ActiveUser.POPUP_STATE state) {
runOnUiThread(new Runnable() {
public void run() {
StringBuilder resultString = new StringBuilder();
resultString.append(String.valueOf(state.getValue()));
Log.d(“CB”, “callback data : “ + resultString);
}
}
}

void noticePopupInfoCBWithData(SHOW_POPUP show, String jsonData)

Description
Java에서 CS_UpdateNoticeGetPopupInfo 함수 호출시 결과를 전달받는 콜백
Return Value

no return value

Parameter

in/out	Type	Name	Description
in	SHOW_POPUP	show	노출해야 할 팝업이 존재하는지 여부
in	String	jsonData	팝업 데이터

Remark
not comment
Sample Code

@Override
public void noticePopupInfoCBWithData(fnal ActiveUser.SHOW_POPUP show, String jsonData) {
runOnUiThread(new Runnable() {
public void run() {
StringBuilder resultString = new StringBuilder();
resultString.append(String.valueOf(show.getValue()))
.append(‘\t’)
.append(jsonData);
Log.d(“CB”, “callback data : “ + resultString);
}
}
}

목차

상수 및 자료형

USER_AGREE_RESULT

ACTIVE_USER_RESULT

SERVER_STATE

SHOW_POPUP

POPUP_STATE_TYPE

REQUEST_PERMISSION_STATE_TYPE

함수

void CS_ActiveUserStart()

void CS_ActiveUserStartEx(SERVER_STATE serverState)

void CS_ActiveUserStartWithoutNotice(SERVER_STATE serverState, int showNotice)

void CS_ActiveUserSetServerId(const char* server_id)

void CS_ActiveUserSetGameLanguage(const char* game_language)

void CS_SetMinTimeoutSeconds(int seconds)

int CS_ActiveUserGetVersion(char* buf, int bufSize)

int CS_ActiveUserSetLogged(int isLogged)

const char* CS_ActiveUserGetDID()

void CS_ActiveUserSetCallback(ActiveUserCB cb)

void CS_UserAgreeSetCallback(UserAgreeCB cb)

void CS_UserAgreeShowTermsUI(void* parentView)

void CS_UserAgreeShowTermsUIEx(void* parentView, const char* url)

void CS_UserAgreeReset()

void CS_ActiveUserSetEnableRequestStoragePermission()

void CS_UpdateNoticeShowPopup(UpdateNoticePopupCB cb)

void CS_UpdateNoticeGetPopupInfo(UpdateNoticeInfoCB cb)

void CS_ActiveUserGetPermissionViewData(PermissionViewDataCB cb)

void CS_ActiveUserSetPermissionViewState(int isOn)

void CS_ActiveUserSendFunnelsLogs(String funnelsTrack, String optionTag)

void CS_ActiveUserRequestUserPermissions(String requests, RequestUserPermissionsCB cb)

Java / C# only

ActiveUser(Activity activity)

void onActivityStarted()

void onActivityStopped()

콜백 함수

typedef void (* UserAgreeCB)(USER_AGREE_RESULT result)

typedef void (* ActiveUserCB)(ACTIVE_USER_RESULT result)

typedef void (* UpdateNoticePopupCB)(POPUP_STATE state)

typedef void (* UpdateNoticeInfoCB)(SHOW_POPUP show, const char* jsonData)

typedef void (* PermissionViewDataCB)(const char* jsonData)

typedef void (* RequestUserPermissionsCB)(REQUEST_PERMISSION_STATE state, const char* grantedPermissions, const char* deniedPermissions)

void noticeShowPopupCBWithData(POPUP_STATE state)

void noticePopupInfoCBWithData(SHOW_POPUP show, String jsonData)