APMS 1.0 API Class Guide

문서 이력관리

​

​

​

​

​

​

​

​

​

​

​

​

1. APMS.Class

1.1 Public Method

public static APMS getInstance(Context context)

• context를 파라미터로 하여 APMS객체를 가져옵니다.

• parameter

  • context -> The application context

• return

  • APMS Class Instance

public static APMSPopup getPopUpInstance()

• context를 파라미터로 하여 APMSPopup객체를 가져옵니다.

• return

  • APMSPopup Class Instance

public static boolean clear()

• APMS Instance를 메모리에서 제거합니다. 앱이 종료되는 시점에 호출해줘야 합니다.

• return

  • true : 정상종료 , false : Clear시 요류발생

public void setCustId(String custId)

• 로그인 시 입력되는 사용자 아이디를 설정합니다.

• parameter

  • custId -> Admin User ID

public void getCustId()

• 로그인 시 입력된 사용자 아이디를 가져옵니다..

• return

  • 현재 사용중인 CustId

public void setPopupSetting (Boolean state, String title)

• APMSPopup 객체를 생성하고 Default Popup을 설정합니다.

• parameter

  • state -> true: Default 사용, false: 사용안함.
  • title -> 팝업 타이틀에 표시될 String

public void setIsPopupActivity(Boolean ispopup)

• 다른앱을 사용시에 팝업을 노출 시킬것인지 말것인지 설정합니다.

• parameter

  • ispopup -> true : 노출안시킴 & false : 노출시킴

public void setNotiOrPopup(Boolean isnotiorpopup)

• 택스트 팝업시 팝업으로 뛰울 것인지 Toast 메세지로 뛰울것인지 설정합니다.

• parameter

  • isnotiorpopup -> true : Toast사용 & false : 팝업창 사용

public void setRingMode(boolean isRingMode)

• Push 수신 시 ring여부를 설정합니다.

• parameter

  • isRingMode -> true : 사용 & false : 사용안함

public void setVibeMode(boolean isVibeMode)

• Push 수신 시 vibe여부를 설정합니다.

• parameter

  • isVibeMode -> true : 사용 & false : 사용안함

public void setPopupNoti(boolean isShowPopup)

• Push 수신 시 popup여부를 설정합니다.

• parameter

  • isShowPopup -> true : 사용 & false : 사용안함

public void setImmediatelySender (Boolean flag)

• 수집한 데이터를 즉시 전송 할 것인지 설정합니다.

• parameter

  • flag -> true : 사용 & false : 사용안함

public void getLocationMode ()

• 설정된 위치 정보를 가져옵니다.

• 위치 정보 발신 설정 정보를 가져옵니다.

• return

  • "Y" or "N"

public void setLocationMode (Boolean flag)

• ReadMsg 시에 위치 정보를 함께 전송 할 것인지 설정합니다.
• parameter

• flag -> true : 사용 & false : 사용안함

public void setSenderTime (int time)

• 수집한 데이터를 설정된 시간에 주기로 발송합니다.

• parameter

  • time -> 초단위의 값 (second 단위)

public void setSenderDataCount (int count)

• 수집한 데이터 최대 발송량입니다.

• parameter

  • count -> 한번 최대 발송량 (Default : 50개)

public String getMsgFlag()

• Push Msg수신 설정 정보를 가져옵니다.

• return

  • "Y" or "N"

public String getNotiFlag()

• 정보성 수신동의 설정 정보를 가져옵니다.

• return

  • "Y" or "N"

public String getMktFlag()

• 마케팅 수신동의 설정 정보를 가져옵니다.

• return

  • "Y" or "N"

public String getEtqStartTime()

• 에티켓 모드 시작 시간을 설정합니다.

• return

  • String 시간값.

public String getEtqEndTime()

• 에티켓 모드 종료 시간을 설정합니다.

• return

  • String 시간값.

public String getMaxUserMsgId()

• 저장된 메세지중 최신 메세지 UserMsgId를 가져옵니다.

• return

  • 저장된 메세지중 최신 메세지 UserMaxId

1.2 Data 수집 관련 Method

• 앱 데이터 수집에 대한 API를 Call할 수 있는 Method입니다.

public void startSession ()

• 데이터 수집을 시작합니다.

public void endSession ()

• 데이터 수집을 종료합니다.

public void setVisit (String code)

• 방문한 페이지에 정보를 저장 & 전달 합니다.

• parameter

  • code -> 해당 페이지에 해당하는 code값.

public void setCart (String code, String quantity)

• 장바구니에 이벤트시 정보를 저장 & 전달합니다.

• parameter

  • code -> 해당 아이템에 해당하는 code값.
  • quantity -> 해당 아이템에 해당하는 quantity값.

public void setPurchase (String code, String quantity, String units)

• 메세지 그룹 전체 리스트를 가져옵니다.

• parameter

  • code -> 해당 구매에 해당하는 code값.
  • quantity -> 해당 구매에 해당하는 quantity값.
  • units -> 해당 구매에 해당하는 units값.

1.3 Database(SQLite) 관련 Method

• SDK에서 사용하는 SQLite에 접근 하는 메소드들을 설명합니다.

public Cursor selectMsgGrpList()

• 메세지 그룹 전체 리스트를 가져옵니다.

• return

  • 메세지 그룹에 대한 리스트

public MsgGrp selectMsGrp(String msgCode)

• 메세지 코드에 해당하는 메세지 그룹을 가져옵니다.

• parameter

  • msgCode -> 조회할려는 MsgCode

• return

  • 조회된 메세지 그룹 코드의 MsgGrp Bean로 이루어진 상세 데이터

public int selectNewMsgCnt()

• 새로운 메시지 수를 가져옵니다.

• return

  • 읽지 않은 메세지의 수

public Cursor selectMsgList (int page, int row)

• 메시지 리스트를 가져옵니다.

• parameter

  • page -> 페이지 값
  • row -> 한번에 가져올 줄수

• return

  • 조건에 해당하는 리스트

public Cursor selectMsgList(String msgCode)

• 메세지 코드에 해당하는 메시지 리스트를 가져옵니다.

• parameter

  • msgCode -> 리스트를 가져올 메세지 그룹 코드

• return

  • 매세지 그룹코드에 해당하는 리스트

public Msg selectMsgWhereMsgId(String msgId)

• MsgId에 해당하는 메시지를 가져옵니다.

• parameter

  • msgId -> 상세 데이터를 가져올 MsgId

• return

  • 검색된 데이터를 Msg Bean 형태로 반환

public Msg selectMsgWhereUserMsgId(String userMsgId)

• UserMsgId에 해당하는 메시지를 가져옵니다.

• parameter

  • userMsgId -> 상세 데이터를 가져올 UserMsgId

• return

  • 검색된 데이터를 Msg Bean형태로 반환

public long updateMsgGrp(String msgCode, ContentValues values)

• 메세지 코드에 맞는 메시지 그룹을 업데이트 합니다.

• parameter

  • msgCode -> 내용을 변경할 메세지 그룹 코드
  • values -> MsgGrp Bean로 구성된 ContentValues

• return

  • 적용된 Row수

public long public long updateReadMsg (String msgGrpCd, String firstUserMsgId, String lastUserMsgId)

• 파라메터 값에 해당하는 메시지그룹의 다수 메세지를 읽음으로 갱신합니다.

• parameter

  • msgGrpCd -> 읽음 으로 처리할 메세지 그룹 코드
  • firstUserMsgId -> 다수 메세지중 처음 UserMsgId
  • lastUserMsgId -> 다수 메세지중 마지막 UserMsgId

• return

  • 적용된 Row수

public long updateReadMsgWhereUserMsgId (String userMsgId)

• UserMsgId에 해당하는 메시지를 읽음으로 갱신합니다.

• parameter

  • userMsgId -> 읽음으로 처리할 UserMsgId

• return

  • 적용된 Row수

public long updateReadMsgWhereMsgId (String msgId)

• MsgId에 해당하는 메시지를 읽음으로 갱신합니다.

• parameter

  • msgId -> 읽음으로 처리할 MsgId

• return

  • 적용된 Row수

public long deleteUserMsgId (String userMsgId)

• UserMsgId에 해당하는 메시지를 삭제합니다.

• parameter

  • userMsgId -> 삭제할 UserMsgId

• return

  • 적용된 Row수

public long deleteMsgId (String MsgId)

• MsgId에 해당하는 메시지를 삭제합니다.

• parameter

  • msgId -> 삭제할 MsgId

• return

  • 적용된 Row수

public long deleteMsgGrp(String msgCode)

• 메세지 그룹 코드에 해당하는 메시지 그룹을 삭제합니다.

• parameter

  • msgCode -> 삭제할 메세지 그룹코드

• return

  • 적용된 Row수

public long deleteExpireMsg ()

• 유효기간이 만료된 메시지를 삭제합니다.

public void deleteEmptyMsgGrp()

• 비어있는 메시지 그룹을 삭제 합니다.

public void deleteAll()

• 모든 데이터를 삭제합니다.

2. APMSPopup.Class

2.1 Public Method

public static APMSPopup getInstance(Context context)

• context를 파라미터로 하여 APMSPopup객체를 가져옵니다.

• parameter

  • context -> The application context

• return

  • APMSPopup Class Instance

public Activity getActivity ()

• Push Popup 에 대한 Activity 값을 가져 옵니다.

• return

  • Push Popup Activity 값

public void commit()

• Push Popup 에 설정한 값들을 저장합니다.
• 설정이 끝난후 꼭 넣어 주셔야 합니다.

public void setDefaultPopup (String titlename)

• Push Popup 에 대한 Default UI를 자동으로 설정합니다.

• parameter

  • titlename -> Push Popup Title 에 등록될 네임값

public void startNotiReceiver()

• Properties 파일에 noti_receiver키값에 등록된 클래스를 실행하는 Methed()

public String getWebLinkUrl()

• Rich Popup시 <a> Tag에 들어있는 URL을 가져옵니다

public void startClickEvent ()

• Rich Popup시 <a> Tag 를 터치시 읽음 처리를 합니다.

2.2 Popup Setting Method

public void setPopUpBackColor(int red, int green, int blue, int alpha)

• APMS Push Popup Layout 전체 백그라운드 색상 & 투명도를 설정합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)
  • alpha -> 0 ~ 255 (255 : Max)

public void setPopupBackImgResource(String filename)

• APMS Push Popup Layout 전체 백그라운드 이미지를 설정합니다.

• parameter

  • filename -> Image File Name (나인패치일 경우 *.9.png 중 * 값만 설정)

public void setTopLayoutFlag(Boolean flag)

• APMS Push Popup Layout 중 상위 Title Bar를 사용 여부.

• parameter

  • flag -> ON & OFF (true & false)

public void setTopBackColor(int red, int green, int blue, int alpha)

• APMS Push Popup Top Layout 백그라운드 색상 & 투명도를 설정합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)
  • alpha -> 0 ~ 255 (255 : Max)

public void setTopBackImgResource(String filename)

• APMS Push Popup Top Layout 백그라운드 이미지를 설정합니다.

• parameter

  • filename -> Image File Name (나인패치일 경우 *.9.png 중 * 값만 설정)

public void setTopTitleType(String type)

• APMS Push Popup Top Layout 의 설정을 Image & text 인지 설정합니다.

• parameter

  • type -> 'text' & 'image'

public void setTopTitleImgResource(String filename)

• APMS Push Popup Top Title 을 이미지를 설정 합니다. (setTopTitleType을 'image'로 설정했을 경우)

• parameter

  • filename -> Image File Name (나인패치일 경우 *.9.png 중 * 값만 설정)

public void setTopTitleName(String name)

• APMS Push Popup Top Title 을 덱스트로 설정 합니다. (setTopTitleType을 'text'로 설정했을 경우)

• parameter

  • name -> Title 넣을 String name 값

public void setTopTitleTextColor(int red, int green, int blue)

• APMS Push Popup Top Title 에 대한 텍스트 색상을 설정 합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)

public void setTopTitleTextSize(int size)

• APMS Push Popup Top Title 에 대한 텍스트 사이즈를 설정 합니다.

• parameter

  • size -> Title Name Text Size (Default : 25px)

public void setContentBackColor(int red, int green, int blue, int alpha)

• APMS Push Popup Top Layout 백그라운드 색상 & 투명도를 설정합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)
  • alpha -> 0 ~ 255 (255 : Max)

public void setContentBackImgResource(String filename)

• APMS Push Popup Content Layout 백그라운드 이미지를 설정합니다.

• parameter

  • filename -> Image File Name (나인패치일 경우 *.9.png 중 * 값만 설정)

public void setContentTextColor(int red, int green, int blue)

• APMS Push Popup Content Title 에 대한 텍스트 색상을 설정 합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)

public void setContentTextSize(int size)

• APMS Push Popup Content 텍스트 사이즈를 설정 합니다.

• parameter

  • size -> Content Text Size (Default : 15px)

public void setBottomBackImgResource(String filename)

• APMS Push Popup Bottom Layout 백그라운드 이미지를 설정합니다.

• parameter

  • filename -> Image File Name (나인패치일 경우 *.9.png 중 * 값만 설정)

public void setBottomBackColor(int red, int green, int blue, int alpha)

• APMS Push Popup Bottom Layout 백그라운드 색상 & 투명도를 설정합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)
  • alpha -> 0 ~ 255 (255 : Max)

public void setBottomTextBtnCount(int count)

• Text Push Popup 에 표시할 버튼 갯수를 설정합니다.

• parameter

  • count -> 버튼 갯수 (1 ~ 2개)

public void setBottomRichBtnCount(int count)

• Rich Push Popup 에 표시할 버튼 갯수를 설정합니다.

• parameter

  • count -> 버튼 갯수 (1 ~ 2개)

public void setBottomBtnImageResource(String... args)

• Push Popup Bottom Button 에 적용할 이미지를 설정합니다.

• parameter

  • args -> Image File Name (나인패치일 경우 *.9.png 중 * 값만 설정)
  • 사용 예시 (버튼 이미지가 btn_1.png & btn_2.9.png 일 경우)

 
    APMSPopup.getInstance(context).setBottomBtnImageResource("btn_1", "btn_2");

public void setBottomTextViewFlag(Boolean state)

• Push Popup Bottom Button 에 텍스트를 사용 할것인지 유 & 무

• parameter

  • state -> ON & OFF (true & false)

public void setBottomBtnTextName(String... name)

• Push Popup Bottom Button Text 값 설정하고, setBottomTextBtnCount 값과 동일해야 합니다.

• parameter

  • name -> 버튼 텍스트 네임 배열값
  • 사용 예시 (버튼 네임이 첫번재 & 두번재일 경우)

 
    APMSPopup.getInstance(context).setBottomBtnTextName("첫번째", "두번쨰");
    APMSPopup.getInstance(context).setBottomTextBtnCount(2);

public void setBottomBtnTextColor(int red, int green, int blue)

• Push Popup Bottom Button Text 값을 설정시 색상을 설정합니다.

• parameter

  • red -> 0 ~ 255 (255 : Max)
  • green -> 0 ~ 255 (255 : Max)
  • blue -> 0 ~ 255 (255 : Max)

public void setBottomBtnTextSize(int size)

• Push Popup Bottom Button Text 값을 설정시 글자 크기을 설정합니다.

• parameter

  • size-> Button Text Size (Default : 15px)

public void setTextBottomBtnClickListener(Object... ocl)

• Text Push Popup 시 버튼에 대한 이벤트를 등록 합니다.

• parameter

  • ocl -> OnClickListener 생성한 객체
  • 버튼 이벤트 매소드 기본형 (필수)

 
    private final btnEventListener btnEvent = new btnEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onClick () {
            ${event_process}
        }
    };

- 사용 예시

 
    APMSPopup.getInstance(context).setTextBottomBtnClickListener(btnEvent1, btnEvent2);
    
    private final btnEventListener btnEvent1 = new btnEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onClick () {
            APMSPopup.getInstance(context).getActivity().finish(); // 팝업창 종료
        }
    };
    
    private final btnEventListener btnEvent2 = new btnEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onClick () {
            APMSPopup.getInstance(context).startNotiReceiver(); // Notification Receiver 호출.
            APMSPopup.getInstance(context).getActivity().finish(); // 팝업창 종료
        }
    };

public void setRichBottomBtnClickListener(Object... ocl)

• Rich Push Popup 시 버튼에 대한 이벤트를 등록 합니다.

• parameter

  • ocl -> OnClickListener 를 생성한 객체
  • 버튼 이벤트 매소드 기본형 (필수)

 
    private final btnEventListener btnEvent = new btnEventListener() {
        private static final long serialVersionUID = 1L;
            
        @Override
        public void onClick(View v) {
            ${event_process}
        }
    }

- 사용 예시

 
    APMSPopup.getInstance(context).setRichBottomBtnClickListener(btnEvent1, btnEvent2);
    
    private final btnEventListener btnEvent1 = new btnEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onClick () {
            APMSPopup.getInstance(context).getActivity().finish(); // 팝업창 종료
        }
    };
    
    private final btnEventListener btnEvent2 = new btnEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onClick () {
            APMSPopup.getInstance(context).startNotiReceiver(); // Notification Receiver 호출.
            APMSPopup.getInstance(context).getActivity().finish(); // 팝업창 종료
        }
    };

public void setRichLinkTouchListener (touchEventListener otl)

• Rich Push Popup 시 <a> Tag에 대한 이벤트를 등록 합니다.

• parameter

  • otl -> touchEventListener 생성한 객체
  • 터치 이벤트 매소드 기본형 (필수)

 
    private final touchEventListener touchEvent = new touchEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onTouch () {
            startClickEvent(); // 필수로 넣으셔야 합니다.
            ${event_process}
        }
    };

- 사용 예시
- `getWebLinkUrl()`는 `<a> Tag`에 들어있는 Url값을 가져옵니다.

 
    APMSPopup.getInstance(context). setRichLinkTouchListener(touchEvent);
    
    private final touchEventListener touchEvent = new touchEventListener() {
​
        private static final long serialVersionUID = 1L;
​
        @Override
        public void onTouch () {
            startClickEvent(); // 필수로 넣으셔야 합니다.
            Intent intent = new Intent(Intent.ACTION_VIEW);
            Uri uri = Uri.parse(getWebLinkUrl());
            intent.setData(uri);
            getActivity().startActivity(intent);
        }
    };

public void setLayoutXMLTextResId (String filename)

• Text Push Popup 을 작성한 Layout XML을 설정합니다.

• parameter

  • filename -> Text Popup Layout XML 파일 이름

public void setLayoutXMLRichResId (String filename)

• Rich Push Popup 을 작성한 Layout XML을 설정합니다.

• parameter

  • filename -> Rich Popup Layout XML 파일 이름

public void setXMLTextButtonType (String...viewtype)

• Text Popup 창 버튼 리소스 종류

• parameter

  • viewtype -> 버튼 리소스 배열값
  • 사용 예시 (버튼 타입이 button & Imageview 일 경우)

 
    APMSPopup.getInstance(context).setXMLTextButtonType ("button", "ImageView")

public void setXMLTextButtonTagName (String...name)

• Text Popup 창 버튼의 Tag Name

• parameter

  • name -> Tag Name 배열값
  • 사용 예시 (버튼 XML Tag명이 button1 & button2 일 경우)

 
    APMSPopup.getInstance(context).setXMLTextButtonTagName ("button1", "button2")

public void setXMLRichButtonType (String...viewtype)

• Rich Popup 창 버튼 리소스 종류

• parameter

  • viewtype -> 버튼 리소스 배열값
  • 사용 예시 (버튼 타입이 button & Imageview 일 경우)

 
    APMSPopup.getInstance(context).setXMLRichButtonType ("button", "ImageView")

public void setXMLRichButtonTagName (String...name)

• Rich Popup 창 버튼의 Tag Name

• parameter

  • name -> Tag Name 배열값
  • 사용 예시 (버튼 XML Tag명이 button1 & button2 일 경우)

 
    APMSPopup.getInstance(context).setXMLRichButtonTagName ("button1", "button2")

3. TAS.Class

3.1 서비스 시작

public static TAS getInstance (Context context)

• context를 파라미터로 하여 TAS 객체를 가져옵니다.

• 자동으로 UncaughtException과 Session을 수집하기 위한 서비스를 시작합니다.

• parameter

  • context -> The application context

• return

  • TAS Class Instance

public static void clear ()

• 앱 종료시 자동 수집 기능을 종료

• return

  • void

3.2 TAS 설정 변경

public void setChannelKeys (String channelKey)

• 라이브러리의 설정을 변경할때 사용합니다.

• TAS에서 발급받은 채널키를 설정합니다. 이 함수로 설정할 경우 properties의 설정값은 무시됩니다.

• parameter

  • channelKey -> 채널키

• return

  • void

3.3 앱 사용자 식별

public void identifyUser (String userId, JSONObject userProp)

• 사용자 식별. 로그인 완료후 호출

• parameter

  • userId -> 식별할 사용자 ID
  • userProp -> 추가로 설정할 사용자 정보

• return

  • void

public void identifyUser (String userId, String email, String phoneNumber, JSONObject userProp)

• 사용자 식별. 로그인 완료후 호출

• parameter

  • userId -> 식별할 사용자 ID
  • email -> 이메일주소
  • phoneNumber -> 전화번호
  • userProp -> 추가로 설정할 사용자 정보

• return

  • void

3.4 이벤트 수집

• TAS에서 제공하는 이벤트 수집함수(커머스, 뷰, 에러)이외에 추가로 수집하고 싶은 이벤트를 트래킹할때 사용

public void logEvent (JSONObject parameters)

• 추가정보를 이용한 수집

• parameter

  • parameters -> 추가로 전달할 정보

• return

  • void

    ​

3.5 뷰 정보 수집

public void logPageViewEvent (String pageName)

• 화면의 이동이 발생했을 때 호출

• parameter

  • pageName -> 페이지 이름

• return

  • void

    ​

3.6 커머스 정보 수집

public void logCartEvent (ArrayList tags)

• 장바구니 이벤트 수집

• parameter

  • tags -> 아이템 코드 목록

• return

  • void

public void logCartAbandonEvent (ArrayList tags)

• 장바구니 유기 이벤트 수집

• parameter

  • tags -> 유기할 아이템 코드 목록

• return

  • void

public void logPurchaseEvent (ArrayList tags, int value)

• 결제 이벤트 수집

• parameter

  • tags -> 결제할 아이템 코드 목록
  • value -> 값

• return

  • void

    ​