Push 모듈 레퍼런스 가이드 (Android)

 

목차

  • 1 상수 및 자료형
    • 1.1 Push_UserSetting
      • Deprecated
    • 1.2 Push_BoolType
    • 1.3 Push_CallbackType
  • 2 함수
    • 2.1 void CS_pushStartEx()
      • Deprecated
    • 2.2 void CS_pushSetPush(Push_BoolType isPush)
    • 2.3 void CS_pushSetSound(Push_UserSetting isSound)
      • Deprecated
    • 2.4 void CS_pushSetVib(Push_UserSetting isVib)
      • Deprecated
    • 2.5 void CS_pushSetAgree(Push_BoolType notice, Push_BoolType night)
    • 2.6 Push_BoolType CS_pushGetPush()
    • 2.7 Push_UserSetting CS_pushGetSound()
      • Deprecated
    • 2.8 Push_UserSetting CS_pushGetVib()
      • Deprecated
    • 2.9 Push_BoolType CS_pushGetAgreeNotice()
    • 2.10 Push_BoolType CS_pushGetAgreeNight()
    • 2.11 void CS_pushRegisterLocalpush(int pushID, char* title, char* msg, char* ticker, char* type, char* icon, char* sound, char* active, long after)
    • 2.12 void CS_pushRegisterLocalpushEx(int pushID, char* title, char* msg, char* ticker, char* type, char* icon, char* sound, char* active, long after, char* broadcastAction)
    • 2.13 void CS_pushRegisterLocalpushBig(int pushID, char* title, char* msg, char* bigmsg, char* ticker, char* type, char* icon, char* sound, char* active, long after, char* broadcastAction)
    • 2.14 void CS_pushRegisterLocalpushData(char* jsonPushData)
    • 2.15 void CS_pushUnRegisterLocalpush(int pushID)
    • 2.16 void CS_pushUnRegisterAllLocalpush()
    • 2.17 void CS_pushRegisterCallbackHandler(PushCallback pushCallback)
    • 2.18 void CS_pushUnRegisterCallbackHandler()
    • 2.19 void CS_pushSetOperationLocalPushOnRunning(int boolean)
    • 2.20 void CS_pushSetOperationGCMPushOnRunning(int boolean)
    • 2.21 int CS_pushGetOperationLocalPushOnRunning()
    • 2.22 int CS_pushGetOperationGCMPushOnRunning()
    • 2.23 char* CS_pushGetRegistrationId()
    • 2.24 void CS_pushSetUid(char* uid)()
    • 2.25 const char* CS_PushGetVersion()
    • 2.26 SetUseTestServer
      • Deprecated
    • 2.27 SetExtendsSenderIDs
    • 2.28 SetUseThirdPartyPush
      • Deprecated
    • 2.29 void CS_pushRequestPermission
  • 3 콜백 함수
    • 3.1 typedef void (*PushCallback)(Push_CallbackType callbackType, int pushID, int remainPushCallback)
    • 3.2 void onReceivedGCMPush(int pushID, int remainPushCallback)
    • 3.3 void onReceivedLocalPush(int pushID, int remainPushCallback)

 

 

상수 및 자료형

<작성법 참고>
Push_UserSetting (Deprecated, C2S.19.6)

Push 설정에 사용하거나 설정 상태로 반환되는 값

* iOS Native, C Plugin

typedef enum Push_UserSetting_ {
    DEFAULT_FALSE   = 0x00,
    DEFAULT_TRUE    = 0x01,
    USER_FALSE      = 0x02,
    USER_TRUE       = 0x03,
    USER_NOTICE     = 0x04,
    USER_NIGHT      = 0x08
} Push_UserSetting;

* Unity Plugin

   public const int DEFAULT_FALSE = 0;
   public const int DEFAULT_TRUE = 1;
   public const int USER_FALSE = 2;
   public const int USER_TRUE = 3;

 
* Android Native

public static final int DEFAULT_FALSE   = 0;   // 00000000
public static final int DEFAULT_TRUE    = 1;   // 00000001

public static final int USER_FALSE        = 0x02;
public static final int USER_TRUE     = 0x03;

<작성법 참고>
Push_BoolType
* Push 설정에 사용하거나 설정 상태로 반환되는 값
* C2S.19.6에서 Push_UserSetting이 deprecated 되고 Push_BoolType으로 설정 값은 0 혹은 1로 사용하도록 변경

* iOS Native, C Plugin

typedef enum Push_BoolType_ {
    Push_FALSE = 0,
    Push_TRUE = 1
} Push_BoolType;

* Unity Plugin

   public const int Push_FALSE = 0;
   public const int Push_TRUE = 1;


* Android Native

public static final int PUSH_FALSE     = 0x00;
public static final int PUSH_TRUE     = 0x01;

<작성법 참고>
Push_CallbackType
Remote Push 혹은 Local Push 여부를 판단하는 값

* iOS Native, C Plugin

typedef enum Push_CallbackType_ {
    onReceivedGCMPush       = 0x01,
    onReceivedLocalPush     = 0x02
} Push_CallbackType;

* Unity Plugin

public const int GCMPush = 1;
public const int LocalPush = 2;

* Android Native

public static final int GCMPush     = 1;
public static final int LocalPush    = 2;

<작성법 참고>

 

함수

void CS_pushStartEx() (Deprecated, C2S.19.6)
  • Description
    Push 모듈을 초기화(시작) 한다.(start() API와 동일한 기능을 수행) 앱 시작 시 1회는 꼭 호출되야 한다.
    (ActiveUser의 CS_ActiveUserStartEx()가 혼전히 끝난 뒤 호출되어야 합니다.)
    iOS의 경우 CS_pushStartEx 함수가 Push v3.5.0d에서 처음으로 소개되었습니다. Push v3.5.0 적용 시 꼭 호출되어야하는 API입니다.
    Android의 C 플러그인의 경우 기존에 start() 함수를 제공하지 않았으나 CS_pushStartEx()가 구성되어 Push v3.5.0부터 사용 가능합니다.
    C2SPushPlugin.cs를 사용하는 경우 Push v3.5.0부터는 Android/iOS 모두 startEx()를 호출하여야 합니다.
    (Push V4를 사용하는 v3.5.0 이후 C2SPushPlugin.cs에서 start()가 더이상 작동하지 않습니다.)
    C2S.19.6 부터는 CS_pushStartEx 호출을 통한 Push 모듈 초기화가 필요하지 않습니다. (ActiveUser 초기화 완료 시 Push 관련 기능이 내부적으로 초기화 됩니다.)
  • Return Value

void

  • Remark
    Java / C# : start() / startEx()
    Available in 3.5.0 and later

 

void CS_pushSetPush(Push_BoolType isPush)
  • Description

    - Push 기능을 on/off 합니다.
    - 게임앱 UI에서 push 기능 on/off 를 구현할 경우 사용합니다.
    - off 상태에서 기존에 예약된 push 작업(Local Push 등)을 제외한 모든 push가 동작하지 않습니다.
    - 예약된 시간 전에 다시 on 상태로 변경할 경우 해당 시간에 알림이 전달됩니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in Push_BoolType isPush

Push 사용 on/off 설정
(0 : off, 1 : on)

  • Remark
    Unity Plugin : public void setPush(int push)
    Android Native : public synchronized void setPush(final int push)

 

void CS_pushSetSound(Push_UserSetting isSound) (Deprecated, C2S.19.6) 
  • Description
    (optional) 게임UI 상 Push Sound on/off 기능이 있을 경우 사용
  • Return Value

void

  • Parameter
in/out Type Name Description
in Push_UserSetting isSound

게임UI 상 Push Sound on/off 기능이 있을 경우 사용합니다.
유저의 푸시 사운드 세팅에 따라 USER_TRUE(push sound on)/ USER_FALSE(push sound off)로 값을 변경합니다.
입력된 값은 파일로 저장되며 앱 실행시 설정값을 다시 불러오게 됩니다.
초기 값은 DEFAULT_TRUE로 설정되며, 입력이 없을 시 DEFAULT_TRUE 값이 유지됩니다.
v2.4.3 부터 DEFAULT_ 는 deprecated 되었으므로 USER_ 만 사용합니다.

  • Remark
    Java / C# : void setSound(int isSound)

 

void CS_pushSetVib(Push_UserSetting isVib) (Deprecated, C2S.19.6)
  • Description
    (optional) 게임UI 상 Push Vibration on/off 기능이 있을 경우 사용
  • Return Value

void

  • Parameter
in/out Type Name Description
in Push_UserSetting isVib

게임UI 상 Push Vibration on/off 기능이 있을 경우 사용합니다.
유저의 푸시 진동 세팅에 따라 USER_TRUE(vibration on) / USER_FALSE(vibration off) 로 값을 변경합니다.
입력된 값은 파일로 저장되며 앱 실행 시 설정값을 다시 불러옵니다.
초기 값은 DEFAULT_TRUE로 설정되며, 입력이 없을 시 DEFAULT_TRUE 값이 유지됩니다.
v2.4.3 부터 DEFAULT_ 는 deprecated 되었으므로 USER_ 만 사용합니다.

  • Remark
    Java / C# : void setVib(int isVib)

 

void CS_pushSetAgree(Push_BoolType notice, Push_BoolType night)
  • Description
    - Push의 공지 알림(notice), 야간 알림(night)의 수신 여부를 설정합니다.
  • Return Value

void

  • Parameter
in/out Type Name Description
in Push_BoolType notice

공지 알림 수신 여부
(0 : 수신 거부, 1 : 수신 허용)

in Push_BoolType night

야간 알림 수신 여부
(0 : 수신 거부, 1 : 수신 허용)

  • Remark
    Unity Plugin : public void setAgree(int notice, int night)
    Android Native : public synchronized void setAgree(int notice, int night)

 

Push_BoolType CS_pushGetPush()
  • Description
    - Push 기능의 on/off 여부 상태를 반환합니다..
  • Return Value

* iOS Native, C Plugin
Push_BoolType / Push 기능 활성 여부(0 : 비활성, 1 : 활성)
* Unity Plugin
int / Push 기능 활성 여부(0 : 비활성, 1 : 활성)
* Android Native
int / Push 기능 활성 여부(0 : 비활성, 1 : 활성)

  • Remark
    Unity Plugin : public int getPush()
    Android Native : public int getPush()

 

Push_UserSetting CS_pushGetSound() (Deprecated, C2S.19.6)
  • Description
    설정된 Push Sound 여부 상태를 return 한다.
  • Return Value

기본 설정은 DEFAULT_TRUE, 그 외 DEFAULT_FALSE, USER_FALSE, USER_TRUE

  • Remark
    Java / C# : int getSound()

 

Push_UserSetting CS_pushGetVib() (Deprecated, C2S.19.6)
  • Description
    설정된 Push Vibration 여부 상태를 return 한다.
  • Return Value

기본 설정은 DEFAULT_TRUE, 그 외 DEFAULT_FALSE, USER_FALSE, USER_TRUE

  • Remark
    Java / C# : int getVib()

 

Push_BoolType CS_pushGetAgreeNotice()
  • Description
    - Push 공지 알림(notice) 수신 여부를 반환합니다.
  • Return Value
* iOS Native, C Plugin
Push_BoolType / Push 공지 알림 수신 여부(0 : 비활성, 1 : 활성)
* Unity Plugin
int / Push 공지 알림 수신 여부(0 : 비활성, 1 : 활성)
* Android Native
int / Push 공지 알림 수신 여부(0 : 비활성, 1 : 활성)
  • Remark
    Unity Plugin : public int getAgreeNotice()
    Android Native : public int getAgreeNotice()

 

Push_BoolType CS_pushGetAgreeNight()
  • Description
    - Push 야간 알림(night) 수신 여부를 반환합니다.
  • Return Value
* iOS Native, C Plugin
Push_BoolType / Push 야간 알림 수신 여부(0 : 비활성, 1 : 활성)
* Unity Plugin
int / Push 야간 알림 수신 여부(0 : 비활성, 1 : 활성)
* Android Native
int / Push 야간 알림 수신 여부(0 : 비활성, 1 : 활성)
  • Remark
    Unity Plugin : public int getAgreeNight()
    Android Native : public int getAgreeNight()

 

 

void CS_pushRegisterLocalpush(int pushID, char* title, char* msg, char* ticker, char* type, char* icon, char* sound, char* active, long after)
  • Description

    - Local Push를 등록합니다.
    - pushID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)

  • Return Value

void

  • Parameter
in/out Type Name Description
in int pushID

- push 알림 고유 id
- 5자리 양수
- 알람 해지나 식별에 사용
- 동일한 id로 등록 시 나중것으로 업데이트

in char* title

유저에게 push로 노출될 타이틀

in char* msg

유저에게 push로 노출될 메시지

in char* ticker

Notification bar에 등록될 때 bar가 flip 되면서 잠시 나타나는 내용

in char* type

(optional)
- push 알림 노출 형태
- default는 “bar”
(ex : “bar”, “popup”, “bar,popup” 3가지 지원)
- bar : notification bar
- popup : popup or toast (화면 on/off 상태에 따라)

in char* icon

(optional)
프로젝트의 res/drawable에 있는 이미지 파일(png)명 사용하여 push 알림 icon으로 사용

in char* sound

(optional)
res/raw에 wav 파일명을 넣어 알림 사운드로 사용

in char* active

(optional)
- “app” : 자신의 앱을 실행 시킴
- “web” : 외부 브라우저를 통해 url 접속
(ex : “web:https://www.withhive.com”)

in long after

(optional)
현재로부터 알림이 전달될 지연 시간(초)

 

void CS_pushRegisterLocalpushEx(int pushID, char* title, char* msg, char* ticker, char* type, char* icon, char* sound, char* active, long after, char* broadcastAction)
  • Description
    - Local Push를 등록합니다.
    - pushID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)
    - CS_pushRegisterLocalpush API에서 broadcastAction 파라메터가 추가된 형태입니다.
  • Return Value

void

  • Parameter
in/out Type Name Description
in int pushID

- push 알림 고유 id
- 5자리 양수
- 알람 해지나 식별에 사용
- 동일한 id로 등록 시 나중것으로 업데이트

in char* title

유저에게 push로 노출될 타이틀

in char* msg

유저에게 push로 노출될 메시지

in char* ticker

Notification bar에 등록될 때 bar가 flip 되면서 잠시 나타나는 내용

in char* type

(optional)
- push 알림 노출 형태
- default는 “bar”
(ex : “bar”, “popup”, “bar,popup” 3가지 지원)
- bar : notification bar
- popup : popup or toast (화면 on/off 상태에 따라)

in char* icon

(optional)
프로젝트의 res/drawable에 있는 이미지 파일(png)명 사용하여 push 알림 icon으로 사용

in char* sound

(optional)
res/raw에 wav 파일명을 넣어 알림 사운드로 사용

in char* active

(optional)
- “app” : 자신의 앱을 실행 시킴
- “web” : 외부 브라우저를 통해 url 접속
(ex : “web:https://www.withhive.com”)

in long after

(optional)
현재로부터 알림이 전달될 지연 시간(초)

in char* broadcastAction

(optional)
알림 수신 시 broadcasting으로 전달할 Action 값

  • Remark
    Unity Plugin : public void registerLocalpush(int pushID, string title, string msg, string ticker, string type, string icon, string sound, string active, long after, string broadcastAction)
    Android Native : public void registerLocalpush(int noticeID, String title, String msg, String ticker, String type, String icon, String sound, String active, long after, String broadcastAction)

 

void CS_pushRegisterLocalpushBig(int pushID, char* title, char* msg, char* bigmsg, char* ticker, char* type, char* icon, char* sound, char* active, long after, char* broadcastAction)
  • Description

    - Local Push를 등록합니다.
    - pushID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)
    - CS_pushRegisterLocalpushEx API에서 bigmsg 파라메터가 추가된 형태입니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in int pushID

- push 알림 고유 id
- 5자리 양수
- 알람 해지나 식별에 사용
- 동일한 id로 등록 시 나중것으로 업데이트

in char* title

유저에게 push로 노출될 타이틀

in char* msg

유저에게 push로 노출될 메시지

in char* bigmsg

(optional)
- 유저에게 BigTextStyle로 표시할 메시지
- 300자 이내
- Android 4.3 이상

in char* ticker

Notification bar에 등록될 때 bar가 flip 되면서 잠시 나타나는 내용

in char* type

(optional)
- push 알림 노출 형태
- default는 “bar”
(ex : “bar”, “popup”, “bar,popup” 3가지 지원)
- bar : notification bar
- popup : popup or toast (화면 on/off 상태에 따라)

in char* icon

(optional)
프로젝트의 res/drawable에 있는 이미지 파일(png)명 사용하여 push 알림 icon으로 사용

in char* sound

(optional)
res/raw에 wav 파일명을 넣어 알림 사운드로 사용

in char* active

(optional)
- “app” : 자신의 앱을 실행 시킴
- “web” : 외부 브라우저를 통해 url 접속
(ex : “web:https://www.withhive.com”)

in long after

(optional)
현재로부터 알림이 전달될 지연 시간(초)

in char* broadcastAction

(optional)
알림 수신 시 broadcasting으로 전달할 Action 값

  • Remark
    Unity Plugin : public void registerLocalpush(int pushID, string title, string msg, string bigmsg, string ticker, string type, string icon, string sound, string active, long after, string broadcastAction)
    Android Native : public void registerLocalpush(int noticeID, String title, String msg, String bigmsg, String ticker, String type, String icon, String sound, String active, long after, String broadcastAction)

 

void CS_pushRegisterLocalpushData(char* jsonPushData)
  • Description

    - Local Push를 등록합니다. 그룹 설정은 해당 API 호출을 통해서만 가능합니다.
    - noticeID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)

    - C2S.21.0 이상 버전에서 groupId 를 설정할 수 있습니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in char* jsonPushData

- Json 형태로 Local Push 등록 시 필요한 정보를 입력

(key 종류 및 type :

noticeID(String), title(String), msg(String), bigmsg(String), ticker(String), type(String), icon(String), sound(String), active(String), after(Long), buckettype(Int), bucketsize(Int), bigpicture(String), icon_color(String), groupId(String)

)

- buckettype : 한 앱의 여러 push 알림을 모아서 보여줄 형태 (1 : 메시지 라인 개행, 2 : 메시지 개행 없이 노출)
- bucketSize : 한 앱의 여러 push 알림을 모아서 보여줄 갯수
- bigpicture : 이미지 url을 입력할 경우 push 알림에 이미지 노출
- icon_color : 아이콘 색상 설정

- groupId : 푸시를 특정 그룹에 포함하여 노출. 설정하지 않을시 기본 앱그룹에 포함하여 노출
  • Remark
    Unity Plugin : public void registerLocalpush(string jsonPushData)
    Android Native : public void registerLocalpush(String jsonStringValue)

 

void CS_pushUnRegisterLocalpush(int pushID)
  • Description

    - 등록된 Local Push를 해지합니다.
    - pushIID를 통해 해지 가능합니다.
    - Remote Push와는 무관합니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in int pushID

- push 알림 고유 id
- 5자리 양수
- 알람 해지나 식별에 사용

  • Remark
    Unity Plugin : public void unRegisterLocalpush(int pushID)
    Android Native : public void unRegisterLocalpush(int pushID)

 

void CS_pushUnRegisterAllLocalpush()
  • Description
    - 등록된 모든 Local Push를 해지합니다.
  • Return Value

void

  • Remark
    Unity Plugin : public void unRegisterAllLocalpush()
    Android Native : public void unRegisterAllLocalpush()

 

void CS_pushRegisterCallbackHandler(PushCallback pushCallback)
  • Description
    - 유저가 Push 터치 시 전달되는 콜백을 등록합니다.
  • Return Value

void

  • Parameter
in/out Type Name Description
in PushCallback pushCallback

구현한 콜백 함수

  • Remark
    Unity Plugin : public void registerUnityCallbackHandler(C2SPushCallback pushCallback)
    Android Native : public synchronized void registerCallbackHandler(com.com2us.module.push.PushCallback _pushCallback)

 

void CS_pushUnRegisterCallbackHandler()
  • Description
    - Push 터치 시 콜백 전달을 위해 PushRegisterCallbackhandler API를 호출하였다면, 해당 API를 통해 콜백를 해지합니다.
  • Return Value

void

  • Remark
    Unity Plugin : public void unRegisterUnityCallbackHandler()
    Android Native : public synchronized void unRegisterCallbackHandler()

 

void CS_pushSetOperationLocalPushOnRunning(int boolean)
  • Description

    - 앱이 foreground에서 활성 상태일 때 Local Push 알림이 동작할지 여부를 설정합니다.
    - Default는 활성(true)이며 비활성(false) 할 경우 앱이 foreground 상태에서 알림이 동작하지 않습니다. 단, 잠금 화면 시에는 동작합니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in int boolean

활성 및 비활성 여부
(0 : 비활성, 1 : 활성)

  • Remark
    Unity Plugin : public void setOperationLocalPushOnRunning(bool b)
    Android Native : public synchronized void setOperationLocalPushOnRunning(boolean b)

 

void CS_pushSetOperationGCMPushOnRunning(int boolean)
  • Description

    - 앱이 foreground에서 활성 상태일 때 Remote Push 알림이 동작할지 여부를 설정합니다.
    - Default는 활성(true)이며 비활성(false) 할 경우 앱이 foreground 상태에서 알림이 동작하지 않습니다. 단, 잠금 화면 시에는 동작합니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in int boolean

활성 및 비활성 여부
(0 : 비활성, 1 : 활성)

  • Remark
    Unity Plugin : public void setOperationGCMPushOnRunning(bool b)
    Android Native : public synchronized void setOperationRemotePushOnRunning(boolean b)

 

int CS_pushGetOperationLocalPushOnRunning()
  • Description
    - PushSetOperationLocalPushOnRunning API로 설정된 상태를 반환합니다.
  • Return Value

* iOS Native, C Plugin
int / 활성 및 비활성 여부 (0 : 비활성, 1 : 활성)
* Unity Plugin
bool / 활성 및 비활성 여부 (false : 비활성, true : 활성)
* Android Native
boolean / 활성 및 비활성 여부 (false : 비활성, true : 활성)

  • Remark
    Unity Plugin : public bool getOperationLocalPushOnRunning()
    Android Native : public synchronized boolean getOperationLocalPushOnRunning()

 

int CS_pushGetOperationGCMPushOnRunning()
  • Description
    - PushSetOperationGCMPushOnRunning API로 설정된 상태를 반환합니다.
  • Return Value

* iOS Native, C Plugin
int / 활성 및 비활성 여부 (0 : 비활성, 1 : 활성)
* Unity Plugin
bool / 활성 및 비활성 여부 (false : 비활성, true : 활성)
* Android Native
boolean / 활성 및 비활성 여부 (false : 비활성, true : 활성)

  • Remark
    Unity Plugin : public bool getOperationGCMPushOnRunning()
    Android Native : public synchronized boolean getOperationRemotePushOnRunning()

 

char* CS_pushGetRegistrationId()
  • Description

    - RegistrationId 값을 반환합니다.
    - 아직 받은 상태가 아닌 경우 빈 문자열을 반환합니다.
    - FCM 사용 시 FCM token을, Amazon Push 사용 시 ADM token을 반환합니다.

  • Return Value
* iOS Native, C Plugin
char* / 현재 모듈이 수신하여 알고 있는 RegistrationId
* Unity Plugin
string / 현재 모듈이 수신하여 알고 있는 RegistrationId
* Android Native
String / 현재 모듈이 수신하여 알고 있는 RegistrationId
  • Remark
    Unity Plugin : public string getRegistrationId()
    Android Native : public String getRegistrationId()

 

void CS_pushSetUid(char* uid) (Deprecated, C2S.19.6)
  • Description
    Push 서버로 UID를 전달한다.
    (ActiveUser의 CS_ActiveUserStartEx()가 온전히 끝난 뒤 호출되어야 합니다.)
  • Return Value

void

  • Remark
    Java / C# : setUID(String uid)
    Available in 3.5.0 and later

 

const char* CS_PushGetVersion()
  • Description

    - Push 모듈 버전을 반환합니다.
    - C2S.19.8.1 패키지 이후 모든 모듈 버전이 패키지 버전과 동일한 값을 갖습니다. (ex : C2S.19.8.1)

  • Return Value
* iOS Native, C Plugin
const char* / Push 모듈 버전 값
* Unity Plugin
string / Push 모듈 버전 값
* Android Native
String / Push 모듈 버전 값
  • Remark
    Unity Plugin : public string getVersion ()
    Android Native : public String getVersion()

   

void setUseTestServer(boolean useTestServer) (Deprecated, C2S.19.6)
  • Description
    TestServer 를 사용할지 선택 한다. 일반적으로 내부 테스트용 외엔 사용되지 않는다. (Android Native, Unity Plugin)
  • Return Value

void

  • Parameter
in/out Type Name Description
in boolean useTestServer

Test Server 를 사용할지 에 대한 flag 값

  • Remark
    added v3.0.0

 

public boolean setExtendsSenderIDs(String... senderIDs)
  • Description

    - Hive Push 서버에서 전달되는 FCM용 senderID 외에 추가적으로 설정이 필요한 경우 호출합니다.
    - Android Native 및 Unity Plugin(Android) API로만 호출 가능한 API 입니다.

  • Return Value

void

  • Parameter
in/out Type Name Description
in String[] senderIDs

senderID 목록

  • Remark
    Unity Plugin : public bool setExtendsSenderIDs(params string[] senderIDs)
    Android Native : public boolean setExtendsSenderIDs(String... senderIDs)

 

void setUseThirdPartyPush(boolean isUseThirdPartyPush) (Deprecated, C2S.19.6)
  • Description
    ThirdPartyPush (ADM, jPush) 를 사용할지 에 대한 flag 함수 (Android Native, Unity Plugin)
  • Return Value

void

  • Parameter
in/out Type Name Description
in boolean isUseThirdPartyPush

ADM 이나 jPush 하나라도 사용하면 true 로 해준다.

  • Remark
    added v3.0.0

 

void CS_pushRequestPermission()
  • Description
    - C2S.20.2.2부터 targetSDK 33 이상으로 빌드된 앱이 Android 13 이상 단말에서 실행될 때 게임에서 필요한 경우 유저에게 명시적으로 푸시 권한 팝업을 노출할 수 있는 API 입니다.
      - 단말이 Android 13인 상태에서 해당 API를 호출하지 않는 앱을 신규 설치하였을 경우 푸시 알람을 못받을 수 있는 가능성이 있습니다. 때문에 C2S.20.2.2를 적용한다면 해당 API 적용을 반드시 확인 바랍니다.
      - 앱의 targetSDK 버전이 33 미만인 상태에서 해당 API가 호출되어도 targetSDK 버전 조건에 맞게 동작합니다.
    - 단, ActiveUser 초기화 완료 뒤에 사용 가능합니다. 호출 시점은 초기화 직후 또는 초기화 이후 게임에서 알림 권한 요청이 필요한 시점에 호출 바랍니다.
  • Return Value

void

  • Parameter
- 없음
  • Remark
    Unity Plugin : public void requestPermission()
    Android Native : public void requestPermission()

 

 

콜백 함수

 

typedef void (*PushCallback)(Push_CallbackType callbackType, int pushID, int remainPushCallback)
  • Description

    - PushRegisterCallbackHandler API 호출로 등록하는 콜백으로, 유저가 Push 터치 시 콜백이 호출되며 관련 정보를 확인할 수 있습니다.
    - 터치 한 Push 알림의 Push_CallbackType(Local Push 혹은 Remote Push 여부) 및 pushID를 확인할 수 있고, remainPushCallback 값을 통해 남아있는 예약된 Push 수를 확인할 수 있습니다.

  • Return Value

no return value

  • Parameter
in/out Type Name Description
in Push_CallbackType callbackType

터치한 Push 알림의 Local Push 혹은 Remote Push 타입.

in int pushID

터치한 Push 알림의 pushID

in int remainPushCallback

남아있는 예약된 Push 수

  • Remark
    Unity Plugin :

    public interface C2SPushCallback { 
       void onReceivedGCMPush (int pushID, int remainPushCallback);
       void onReceivedLocalPush (int pushID, int remainPushCallback);
    }


    Android Native : 

    public interface PushCallback {
       public void onReceivedGCMPush(int pushID, int remainPushCallback);
       public void onReceivedLocalPush(int pushID, int remainPushCallback);
    }

  • Sample Code
void PushCallbackFunc(Push_CallbackType callbackType, int pushID, int remainPushCallbackNum) {

    CS_knlPrintk(" --- > PushCallbackFunc reamainPushNum : %d", remainPushCallbackNum);

    switch(callbackType) {
    case onReceivedGCMPush:
        CS_knlPrintk(" --- > GCM_Push : %d", pushID);
        break;
    case onReceivedLocalPush:
        CS_knlPrintk(" --- > Local_Push : %d", pushID);
        break;
    default:
        CS_knlPrintk(" --- > PushCallback Default : %d, pushID : %d", callbackType, pushID);
        break;
    }
}