v4_api_reference/CPP/_h_i_v_e___push_8h_source.html

#ifndef __HIVE_PUSH_H__

#define  __HIVE_PUSH_H__


#include "HIVE_ResultAPI.h"


NS_HIVE_BEGIN


class ResultAPI;


class RemotePush;

class LocalPush;

class PushSetting;


class HIVESDK_DLLEXPORT Push

{

public:


    typedef std::function<void(ResultAPI const & result, RemotePush const & remotePush)> onRemotePush;


    typedef std::function<void(ResultAPI const & result, LocalPush const & localPush)> onLocalPush;


    // MARK: #12076: Foreground Push Handler

    typedef std::function<void(ResultAPI const &result, PushSetting const &pushSetting)> onPushSetting;

    // MARK: -


    static void getRemotePush(onRemotePush listener);


    static void setRemotePush(RemotePush remotePush, onRemotePush listener);


    static void registerLocalPush(LocalPush localPush, onLocalPush listener);


    static void unregisterLocalPush(int noticeId);


    static void unregisterLocalPushes(std::vector<int> noticeIDs);


    static void unregisterAllLocalPushes();


    // MARK: #12076: Push Setting

    static void setForegroundPush(PushSetting setting, onPushSetting listener);


    static void getForegroundPush(onPushSetting listener);


    static void requestPushPermission();

    // MARK: -


    // \~korean Native 영역에서 호출된 요청을 처리하기 위한 플러그인 내부 코드

    // \~english Plug-in internal code to handle requests invoked from the native code.

    static void executeEngine(picojson::value jsonParam);


};


class HIVESDK_DLLEXPORT RemotePush {


public:


    bool isAgreeNotice;


    bool isAgreeNight;


    RemotePush();


    RemotePush(bool isAgreeNotice, bool isAgreeNight);


    RemotePush(picojson::value jsonParam);


    picojson::object toJson() const;


    std::string toString() const;

};


class HIVESDK_DLLEXPORT LocalPush

{

public:


    int noticeId;


    std::string title;


    std::string msg;


    long after;


    std::string groupId;


    // \~korean 이하 Android에서 로컬 푸시를 커스터마이징하기 위한 필드 정의

    // \~english Followings are field definition for customizing local push on Android.


    std::string bigmsg;


    std::string ticker;


    std::string type;


    std::string icon;


    std::string sound;


    std::string active;


    std::string broadcastAction;

    int buckettype;

    int bucketsize;

    std::string bigpicture;

    std::string icon_color;


    LocalPush();


    LocalPush(int noticeID, std::string title, std::string msg, long after);


    LocalPush(picojson::value jsonParam);


    picojson::object toJson() const;


    std::string toString() const;

};


// MARK: #12076 Push Setting

class HIVESDK_DLLEXPORT PushSetting

{

public:


    bool useForegroundRemotePush;

    bool useForegroundLocalPush;


    PushSetting();


    PushSetting(bool useForegroundRemotePush, bool useForegroundLocalPush);


    PushSetting(picojson::value jsonParam);


    picojson::object toJson() const;


    std::string toString() const;

};

// MARK: -


NS_HIVE_END     // namespace hive


#endif      // __HIVE_PUSH_H__


HIVE_ResultAPI.h

LocalPush
로컬 푸시 등록 정보
Definition: HIVE_Push.h:270

LocalPush::after
long after
알림 시점
Definition: HIVE_Push.h:279

LocalPush::icon
std::string icon
푸시 아이콘
Definition: HIVE_Push.h:293

LocalPush::title
std::string title
로컬 푸시 타이틀
Definition: HIVE_Push.h:275

LocalPush::active
std::string active
수행할 동작
Definition: HIVE_Push.h:297

LocalPush::ticker
std::string ticker
메시지 티커
Definition: HIVE_Push.h:289

LocalPush::sound
std::string sound
푸시 알림음
Definition: HIVE_Push.h:295

LocalPush::msg
std::string msg
로컬 푸시 메시지
Definition: HIVE_Push.h:277

LocalPush::groupId
std::string groupId
알림 그룹 ID
Definition: HIVE_Push.h:281

LocalPush::noticeId
int noticeId
로컬 푸시 통지 ID
Definition: HIVE_Push.h:273

LocalPush::type
std::string type
알림 형태 (bar, popup, toast 등)
Definition: HIVE_Push.h:291

LocalPush::bigmsg
std::string bigmsg
큰 글씨
Definition: HIVE_Push.h:287

Push
모바일 게임에서 푸시 통지 서비스는 게임 유저의 리텐션(잔존율)을 올리기 위한 중요 수단을 제공한다.
Definition: HIVE_Push.h:56

PushSetting
푸시 설정 정보
Definition: HIVE_Push.h:326

PushSetting::useForegroundLocalPush
bool useForegroundLocalPush
앱 활성화 시 로컬 푸시 수신 여부
Definition: HIVE_Push.h:330

PushSetting::useForegroundRemotePush
bool useForegroundRemotePush
앱 활성화 시 리모트 푸시 수신 여부
Definition: HIVE_Push.h:329

RemotePush
유저가 푸시를 수신하는 상태 정보
Definition: HIVE_Push.h:241

RemotePush::isAgreeNotice
bool isAgreeNotice
공지 푸시 수신 허용 여부
Definition: HIVE_Push.h:245

RemotePush::isAgreeNight
bool isAgreeNight
야간 푸시 수신 허용 여부
Definition: HIVE_Push.h:247

ResultAPI
Definition: HIVE_ResultAPI.h:63

Push::setRemotePush
static void setRemotePush(RemotePush remotePush, onRemotePush listener)
유저의 푸시 수신 상태 설정

Push::onPushSetting
std::function< void(ResultAPI const &result, PushSetting const &pushSetting)> onPushSetting
앱 활성화 시 푸시 설정 결과 통지
Definition: HIVE_Push.h:103

Push::getRemotePush
static void getRemotePush(onRemotePush listener)
유저의 푸시 수신 상태 조회

Push::unregisterLocalPushes
static void unregisterLocalPushes(std::vector< int > noticeIDs)
로컬 푸시 해제

Push::unregisterLocalPush
static void unregisterLocalPush(int noticeId)
로컬 푸시 해제

Push::unregisterAllLocalPushes
static void unregisterAllLocalPushes()
Hive 로컬푸시를 포함한 모든 로컬 푸시 해제

Push::onRemotePush
std::function< void(ResultAPI const &result, RemotePush const &remotePush)> onRemotePush
유저의 푸시 수신 상태를 조회한 결과 통지
Definition: HIVE_Push.h:72

Push::onLocalPush
std::function< void(ResultAPI const &result, LocalPush const &localPush)> onLocalPush
로컬 푸시 등록 결과 통지
Definition: HIVE_Push.h:87

Push::requestPushPermission
static void requestPushPermission()
Push Token 명시적 권한 요청

Push::registerLocalPush
static void registerLocalPush(LocalPush localPush, onLocalPush listener)
로컬 푸시 등록.

Push::getForegroundPush
static void getForegroundPush(onPushSetting listener)
앱 활성화 시 푸시 수신 여부 설정 값 조회

Push::setForegroundPush
static void setForegroundPush(PushSetting setting, onPushSetting listener)
앱 활성화 시 푸시 수신 여부 설정 값 적용