com.kakao.push

Class PushMessageBuilder

java.lang.Object

com.kakao.push.PushMessageBuilder

public class PushMessageBuilder
extends Object

자기 자신에게 보내는 푸시 메시지를 구성하는 빌더.

Constructor Summary

Constructors

Constructor and Description
PushMessageBuilder()

Method Summary

Modifier and Type	Method and Description
PushMessageBuilder	setCollapse(String collapse) 푸시 메시지 구분자.
PushMessageBuilder	setCustomField(Map<String,?> customField) 메시지 외 앱에 부가적인 정보를 전달하고자 할 때 사용.
PushMessageBuilder	setDryRun(Boolean dryRun) 테스트를 위해 사용.
PushMessageBuilder	setNotification(Map<String,?> notification) 알림 페이로드를 구성하는데 https://firebase.google.com/docs/cloud-messaging/http-server-ref
PushMessageBuilder	setPriority(String priority) 단말이 도즈모드 상태에서도 푸시를 받을 수 있도록 한다.(기본값 normal)
PushMessageBuilder	setReturnUrl(String returnUrl) 푸시 알림의 전송 실패에 대한 피드백 처리가 필요할 때 사용한다.
PushMessageBuilder	setTimeToLive(Long timeToLive)
String	toString() 푸시 메시지를 String으로 변환.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PushMessageBuilder

public PushMessageBuilder()

Method Detail

setCollapse

public PushMessageBuilder setCollapse(String collapse)

푸시 메시지 구분자. 같은 값을 가지는 푸시 알림이 여러 개일 때 마지막 하나만 사용자 기기로 전송되도록 하기 위해 사용한다.

Parameters:

collapse - 푸시 메시지 구분자

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

setCustomField

public PushMessageBuilder setCustomField(Map<String,?> customField)

메시지 외 앱에 부가적인 정보를 전달하고자 할 때 사용. APNS와 다르게 푸시 알림 한 건의 전체 길이가 4KB까지 가능

Parameters:

customField -

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

setDryRun

public PushMessageBuilder setDryRun(Boolean dryRun)

테스트를 위해 사용. 실제 단말에 전송되지 않는다.

Parameters:

dryRun - true if

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

setNotification

public PushMessageBuilder setNotification(Map<String,?> notification)

알림 페이로드를 구성하는데 https://firebase.google.com/docs/cloud-messaging/http-server-ref

Parameters:

notification - notification message as Map instance

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

setPriority

public PushMessageBuilder setPriority(String priority)

단말이 도즈모드 상태에서도 푸시를 받을 수 있도록 한다.(기본값 normal)

Parameters:

priority - "high" or "normal"

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

setReturnUrl

public PushMessageBuilder setReturnUrl(String returnUrl)

푸시 알림의 전송 실패에 대한 피드백 처리가 필요할 때 사용한다. 전송 실패시 설정된 url로 사용자 id, 푸시 토큰, 전송 실패 시각(millisecond)을 POST로 전송된다.

Parameters:

returnUrl - 푸시 전송 실패시 콜백 받을 url

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

setTimeToLive

public PushMessageBuilder setTimeToLive(Long timeToLive)

Parameters:

timeToLive - GCM에 저장될 미전송메시지 보관주기.(단위:초)

Returns:

계속해서 푸시 메시지를 구성할 수 있는 빌더

toString

public String toString()

푸시 메시지를 String으로 변환.

Overrides:

toString in class Object

Returns:

String으로 변환된 푸시 메시지 객체.