목차
|
* 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; * Android Native
public static final int DEFAULT_FALSE = 0; // 00000000 |
* 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; * Android Native public static final int PUSH_FALSE = 0x00; |
* 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 static final int GCMPush = 1; |
void |
- Push 기능을 on/off 합니다.
- 게임앱 UI에서 push 기능 on/off 를 구현할 경우 사용합니다.
- off 상태에서 기존에 예약된 push 작업(Local Push 등)을 제외한 모든 push가 동작하지 않습니다.
- 예약된 시간 전에 다시 on 상태로 변경할 경우 해당 시간에 알림이 전달됩니다.
void |
in/out | Type | Name | Description |
---|---|---|---|
in | Push_BoolType | isPush |
Push 사용 on/off 설정 |
void |
in/out | Type | Name | Description |
---|---|---|---|
in | Push_UserSetting | isSound |
게임UI 상 Push Sound on/off 기능이 있을 경우 사용합니다. |
void |
in/out | Type | Name | Description |
---|---|---|---|
in | Push_UserSetting | isVib |
게임UI 상 Push Vibration on/off 기능이 있을 경우 사용합니다. |
void |
in/out | Type | Name | Description |
---|---|---|---|
in | Push_BoolType | notice |
공지 알림 수신 여부 |
in | Push_BoolType | night |
야간 알림 수신 여부 |
* iOS Native, C Plugin |
기본 설정은 DEFAULT_TRUE, 그 외 DEFAULT_FALSE, USER_FALSE, USER_TRUE |
기본 설정은 DEFAULT_TRUE, 그 외 DEFAULT_FALSE, USER_FALSE, USER_TRUE |
- Local Push를 등록합니다.
- pushID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)
void |
in/out | Type | Name | Description |
---|---|---|---|
in | int | pushID |
- push 알림 고유 id |
in | char* | title |
유저에게 push로 노출될 타이틀 |
in | char* | msg |
유저에게 push로 노출될 메시지 |
in | char* | ticker |
Notification bar에 등록될 때 bar가 flip 되면서 잠시 나타나는 내용 |
in | char* | type |
(optional) |
in | char* | icon |
(optional) |
in | char* | sound |
(optional) |
in | char* | active |
(optional) |
in | long | after |
(optional) |
void |
in/out | Type | Name | Description |
---|---|---|---|
in | int | pushID |
- push 알림 고유 id |
in | char* | title |
유저에게 push로 노출될 타이틀 |
in | char* | msg |
유저에게 push로 노출될 메시지 |
in | char* | ticker |
Notification bar에 등록될 때 bar가 flip 되면서 잠시 나타나는 내용 |
in | char* | type |
(optional) |
in | char* | icon |
(optional) |
in | char* | sound |
(optional) |
in | char* | active |
(optional) |
in | long | after |
(optional) |
in | char* | broadcastAction |
(optional) |
- Local Push를 등록합니다.
- pushID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)
- CS_pushRegisterLocalpushEx API에서 bigmsg 파라메터가 추가된 형태입니다.
void |
in/out | Type | Name | Description |
---|---|---|---|
in | int | pushID |
- push 알림 고유 id |
in | char* | title |
유저에게 push로 노출될 타이틀 |
in | char* | msg |
유저에게 push로 노출될 메시지 |
in | char* | bigmsg |
(optional) |
in | char* | ticker |
Notification bar에 등록될 때 bar가 flip 되면서 잠시 나타나는 내용 |
in | char* | type |
(optional) |
in | char* | icon |
(optional) |
in | char* | sound |
(optional) |
in | char* | active |
(optional) |
in | long | after |
(optional) |
in | char* | broadcastAction |
(optional) |
- Local Push를 등록합니다. 그룹 설정은 해당 API 호출을 통해서만 가능합니다.
- noticeID, title, msg, ticker는 필수로 입력이 필요합니다. (나머지 항목은 optional)
- C2S.21.0 이상 버전에서 groupId 를 설정할 수 있습니다.
void |
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 : 메시지 개행 없이 노출) |
- 등록된 Local Push를 해지합니다.
- pushIID를 통해 해지 가능합니다.
- Remote Push와는 무관합니다.
void |
in/out | Type | Name | Description |
---|---|---|---|
in | int | pushID |
- push 알림 고유 id |
void |
void |
in/out | Type | Name | Description |
---|---|---|---|
in | PushCallback | pushCallback |
구현한 콜백 함수 |
void |
- 앱이 foreground에서 활성 상태일 때 Local Push 알림이 동작할지 여부를 설정합니다.
- Default는 활성(true)이며 비활성(false) 할 경우 앱이 foreground 상태에서 알림이 동작하지 않습니다. 단, 잠금 화면 시에는 동작합니다.
void |
in/out | Type | Name | Description |
---|---|---|---|
in | int | boolean |
활성 및 비활성 여부 |
- 앱이 foreground에서 활성 상태일 때 Remote Push 알림이 동작할지 여부를 설정합니다.
- Default는 활성(true)이며 비활성(false) 할 경우 앱이 foreground 상태에서 알림이 동작하지 않습니다. 단, 잠금 화면 시에는 동작합니다.
void |
in/out | Type | Name | Description |
---|---|---|---|
in | int | boolean |
활성 및 비활성 여부 |
* iOS Native, C Plugin |
* iOS Native, C Plugin |
- RegistrationId 값을 반환합니다.
- 아직 받은 상태가 아닌 경우 빈 문자열을 반환합니다.
- FCM 사용 시 FCM token을, Amazon Push 사용 시 ADM token을 반환합니다.
void |
- Push 모듈 버전을 반환합니다.
- C2S.19.8.1 패키지 이후 모든 모듈 버전이 패키지 버전과 동일한 값을 갖습니다. (ex : C2S.19.8.1)
void |
in/out | Type | Name | Description |
---|---|---|---|
in | boolean | useTestServer |
Test Server 를 사용할지 에 대한 flag 값 |
- Hive Push 서버에서 전달되는 FCM용 senderID 외에 추가적으로 설정이 필요한 경우 호출합니다.
- Android Native 및 Unity Plugin(Android) API로만 호출 가능한 API 입니다.
void |
in/out | Type | Name | Description |
---|---|---|---|
in | String[] | senderIDs |
senderID 목록 |
void |
in/out | Type | Name | Description |
---|---|---|---|
in | boolean | isUseThirdPartyPush |
ADM 이나 jPush 하나라도 사용하면 true 로 해준다. |
void |
- PushRegisterCallbackHandler API 호출로 등록하는 콜백으로, 유저가 Push 터치 시 콜백이 호출되며 관련 정보를 확인할 수 있습니다.
- 터치 한 Push 알림의 Push_CallbackType(Local Push 혹은 Remote Push 여부) 및 pushID를 확인할 수 있고, remainPushCallback 값을 통해 남아있는 예약된 Push 수를 확인할 수 있습니다.
no return value |
in/out | Type | Name | Description |
---|---|---|---|
in | Push_CallbackType | callbackType |
터치한 Push 알림의 Local Push 혹은 Remote Push 타입. |
in | int | pushID |
터치한 Push 알림의 pushID |
in | int | remainPushCallback |
남아있는 예약된 Push 수 |
public interface C2SPushCallback {
void onReceivedGCMPush (int pushID, int remainPushCallback);
void onReceivedLocalPush (int pushID, int remainPushCallback);
}
public interface PushCallback {
public void onReceivedGCMPush(int pushID, int remainPushCallback);
public void onReceivedLocalPush(int pushID, int remainPushCallback);
}
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; } } |