com.rationalowl.minerva.appserver

Class AppServerManager

java.lang.Object

com.rationalowl.minerva.appserver.AppServerManager

public class AppServerManager
extends java.lang.Object

Author:

jungdo 단말앱에게 API 인터페이스 제공

Field Summary

Fields

Modifier and Type	Field and Description
static int	MSG_ENCRYPT_SET
static int	MSG_ENCRYPT_UNSET
static int	SILENT_PUSH_SET
static int	SILENT_PUSH_UNSET

Method Summary

Modifier and Type	Method and Description
java.lang.String	addDeviceGroup(java.lang.String groupId, java.util.ArrayList<java.lang.String> deviceList) 단말 그룹에 단말을 추가한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	batchMsgDeviceDetailTracking(java.util.ArrayList<java.lang.String> msgIds, int msgStateFlag) 다수의 메시지 상태별 단말앱 상세 정보를 실시간 확인한다.
java.lang.String	batchMsgDevicesTracking(java.util.ArrayList<java.lang.String> msgIds, int msgStateFlag) 다수의 메시지 상태별 단말앱 목록을 실시간 확인한다.
void	clearAutoMsgTrackingListener() 기존에 등록한 메시지 트래킹 리스너를 해제한다.
void	clearDeviceGroupListener() 앱서버에서 등록한 단말그룹관리 리스너를 해제한다.
void	clearDeviceSyncListener() 앱서버에서 등록한 단말앱 동기화 리스너를 해제한다.
void	clearFileStorageListener() 지정된 파일스토리지 리스너를 해제한다.
void	clearMsgListener() 앱서버에서 등록한 메시지 리스너를 해제한다.
void	clearMsgTrackingListener() 등록한 메시지 트래킹 리스너를 해제한다.
void	clearRegisterResultListener() 앱서버에서 등록한 단말 등록 리스너를 해제한다.
java.lang.String	createDeviceGroup(java.lang.String groupName, java.lang.String groupDesc, java.util.ArrayList<java.lang.String> deviceList) 단말 그룹을 생성한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	deleteDeviceGroup(java.lang.String groupId) 단말 그룹을 삭제한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	downloadFile(java.lang.String fileId, java.nio.file.Path filePath) 파일스토리지서버에서 파일을 다운로드하여 로컬 파일경로에 저장한다. setFileStorageListener()로 등록한 FileStorageListener의 콜백을 통해 다운로드 진행률과 다운로드 결과를 확인한다.
java.lang.String	getDeviceIds(int startIndex, int fetchSize) 서비스 내 유효한 단말앱 아이디 목록을 요청한다.
static AppServerManager	getInstance()
java.lang.String	getSynchronizedGroupDeviceIds(java.lang.String deviceGroupId, int startIndex, int fetchSize) 본 API가 호출되면 단말 그룹 내 동기화 작업이 수행되고 단말그룹내 내 유효한 단말앱 아이디 목록이 콜백으로 전달된다.
void	initAppServer()
java.lang.String	msgDeviceDetailTracking(java.lang.String msgId, int msgStateFlag, int deviceTypeFlag, int startIndex, int fetchSize) 메시지 상태별 단말앱 상세정보를 실시간 확인한다.
java.lang.String	msgDevicesTracking(java.lang.String msgId, int msgStateFlag, int deviceTypeFlag, int startIndex, int fetchSize) 메시지 상태별 단말앱 목록을 실시간 확인한다.
java.lang.String	msgStatsTracking(java.util.ArrayList<java.lang.String> msgIds) 메시지 전달 통계 데이터를 실시간 확인한다.
java.lang.String	registerAppServer(java.lang.String serviceId, java.lang.String regName, java.lang.String gateHost, int gatePort)
java.lang.String	registerAppServer(java.lang.String serviceId, java.lang.String regName, java.lang.String gateHost, int gatePort, boolean isPrivateNetwork) 앱서버를 등록 및 구동한다.
java.lang.String	retryCustomPush(java.lang.String msgId, int retryOption) 커스텀 푸시 발신 API로 발신한 메시지 중 미전달 큐잉 혹은 메시지 미확인 단말들에게 재 발송한다.
java.lang.String	sendBroadcastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data) 모든 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendBroadcastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, boolean isSilentPush) 모든 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendBroadcastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, boolean isSilentPush, boolean encryptSet) 모든 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendBroadcastMsg(java.lang.String data) 고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendBroadcastMsg(java.lang.String data, boolean supportMsgQ, java.lang.String notiTitle, java.lang.String notiBody) 고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendBroadcastMsg(java.lang.String data, boolean supportMsgQ, java.lang.String notiTitle, java.lang.String notiBody, java.lang.String notiSound) 고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendGroupCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, java.lang.String deviceGroupId) 단말 그룹에 등록된 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendGroupCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, java.lang.String deviceGroupId, boolean isSilentPush) 단말 그룹에 등록된 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendGroupCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, java.lang.String deviceGroupId, boolean isSilentPush, boolean encryptSet) 단말 그룹에 등록된 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendGroupMsg(java.lang.String data, java.lang.String deviceGroupId) 단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendGroupMsg(java.lang.String data, java.lang.String deviceGroupId, boolean supportMsgQ, java.lang.String notiTitle, java.lang.String notiBody) 단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendGroupMsg(java.lang.String data, java.lang.String deviceGroupId, boolean supportMsgQ, java.lang.String notiTitle, java.lang.String notiBody, java.lang.String notiSound) 단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendMulticastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, java.util.ArrayList<java.lang.String> deviceRegIds) 한대 이상의 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendMulticastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, java.util.ArrayList<java.lang.String> deviceRegIds, boolean isSilentPush) 한대 이상의 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendMulticastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data, java.util.ArrayList<java.lang.String> deviceRegIds, boolean isSilentPush, boolean encryptSet) 한대 이상의 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다.
java.lang.String	sendMulticastMsg(java.lang.String data, java.util.ArrayList<java.lang.String> deviceRegIds) 한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendMulticastMsg(java.lang.String data, java.util.ArrayList<java.lang.String> deviceRegIds, boolean supportMsgQ, java.lang.String notiTitle, java.lang.String notiBody) 한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	sendMulticastMsg(java.lang.String data, java.util.ArrayList<java.lang.String> deviceRegIds, boolean supportMsgQ, java.lang.String notiTitle, java.lang.String notiBody, java.lang.String notiSound) 한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	setAutoMsgTracking(boolean set)
void	setAutoMsgTrackingListener(AutoMsgTrackingListener listener) 메시지 전달 트래킹 상태 변화시마다 이를 처리할 리스너를 설정한다.
void	setDeviceGroupListener(DeviceGroupListener listener) 단말 그룹 관리 API호출후 결과를 처리할 리스너를 등록한다.
void	setDeviceSyncListener(DeviceSyncListener listener) 단말앱 동기화 API 결과를 처리할 리스너 현재 삭제된 단말앱 목록을 등록해제하는 unregisterDevices API가 유일한 단말앱 동기화 API이다.
void	setFileStorageListener(FileStorageListener listener) 파일스토리지 리스너를 등록한다.
void	setMsgListener(MessageListener listener) 다운스트림 메시지 발신 결과와 업스트림 메시지 수신을 처리할 리스너를 등록한다.
void	setMsgTrackingListener(MsgTrackingListener listener) 메시지 트래킹 API 호출후 결과를 처리할 리스너를 등록한다.
void	setRegisterResultListener(AppServerRegisterResultListener listener) 단말 등록 결과를 처리할 리스너를 등록한다.
java.lang.String	subtractDeviceGroup(java.lang.String groupId, java.util.ArrayList<java.lang.String> deviceList) 단말 그룹에서 단말을 제거한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다.
java.lang.String	unregisterAppServer(java.lang.String serviceId, java.lang.String serverRegId) 앱서버를 등록해제한다. setRegisterResultListener()로 등록한 AppServerRegisterResultListener의 콜백을 통해 등록 헤제 결과를 확인한다.
java.lang.String	unregisterDevices(java.util.ArrayList<java.lang.String> deviceIds) 단말 그룹을 삭제한다.
java.lang.String	uploadFile(java.nio.file.Path filePath) 파일을 파일 스토리지에 업로드한다. setFileStorageListener()로 등록한 FileStorageListener의 콜백을 통해 업로드 진행률과 업로드 결과를 확인한다.

Methods inherited from class java.lang.Object

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

Field Detail

SILENT_PUSH_UNSET

public static final int SILENT_PUSH_UNSET

See Also:

Constant Field Values

SILENT_PUSH_SET

public static final int SILENT_PUSH_SET

See Also:

Constant Field Values

MSG_ENCRYPT_UNSET

public static final int MSG_ENCRYPT_UNSET

See Also:

Constant Field Values

MSG_ENCRYPT_SET

public static final int MSG_ENCRYPT_SET

See Also:

Constant Field Values

Method Detail

getInstance

public static AppServerManager getInstance()

setRegisterResultListener

public void setRegisterResultListener(AppServerRegisterResultListener listener)

단말 등록 결과를 처리할 리스너를 등록한다.

Parameters:

listener - registerAppServer API를 통해 등록요청한 결과를 처리할 리스너 이후 registerAppServer()API 호출시 listener의 onRegisterResult() 콜백에서 결과를 확인한다.

clearRegisterResultListener

public void clearRegisterResultListener()

앱서버에서 등록한 단말 등록 리스너를 해제한다. 이후 listener의 콜백이 호출되지 않는다.

setMsgListener

public void setMsgListener(MessageListener listener)

다운스트림 메시지 발신 결과와 업스트림 메시지 수신을 처리할 리스너를 등록한다.

Parameters:

listener - 다운스트림 메시지 발신 결과와 업스트림 메시지 수신시 처리할 리스너

clearMsgListener

public void clearMsgListener()

앱서버에서 등록한 메시지 리스너를 해제한다. 이후 메시지 리스너의 콜백이 호출되지 않는다.

setDeviceSyncListener

public void setDeviceSyncListener(DeviceSyncListener listener)

단말앱 동기화 API 결과를 처리할 리스너 현재 삭제된 단말앱 목록을 등록해제하는 unregisterDevices API가 유일한 단말앱 동기화 API이다.

Parameters:

listener - 단말 그룹 관리 API결과를 처리할 리스너

clearDeviceSyncListener

public void clearDeviceSyncListener()

앱서버에서 등록한 단말앱 동기화 리스너를 해제한다. 이후 리스너의 콜백이 호출되지 않는다.

setDeviceGroupListener

public void setDeviceGroupListener(DeviceGroupListener listener)

단말 그룹 관리 API호출후 결과를 처리할 리스너를 등록한다.

Parameters:

listener - 단말 그룹 관리 API결과를 처리할 리스너

clearDeviceGroupListener

public void clearDeviceGroupListener()

앱서버에서 등록한 단말그룹관리 리스너를 해제한다. 이후 리스너의 콜백이 호출되지 않는다.

setMsgTrackingListener

public void setMsgTrackingListener(MsgTrackingListener listener)

메시지 트래킹 API 호출후 결과를 처리할 리스너를 등록한다.

Parameters:

listener - 메시지 트래킹 API결과를 처리할 리스너

clearMsgTrackingListener

public void clearMsgTrackingListener()

등록한 메시지 트래킹 리스너를 해제한다. 이후 리스너의 콜백이 호출되지 않는다.

setAutoMsgTrackingListener

public void setAutoMsgTrackingListener(AutoMsgTrackingListener listener)

메시지 전달 트래킹 상태 변화시마다 이를 처리할 리스너를 설정한다.

Parameters:

listener - 자동 콜백 리스너

clearAutoMsgTrackingListener

public void clearAutoMsgTrackingListener()

기존에 등록한 메시지 트래킹 리스너를 해제한다. 이후 리스너의 콜백이 호출되지 않는다.

setFileStorageListener

public void setFileStorageListener(FileStorageListener listener)

파일스토리지 리스너를 등록한다.

Parameters:

listener - uploadFile()과 downloadFile() API를 통해 진행되는 파일업로드 및 다운로드 진행결과를 처리할 리스너를 지정한다.

clearFileStorageListener

public void clearFileStorageListener()

지정된 파일스토리지 리스너를 해제한다.

registerAppServer

public java.lang.String registerAppServer(java.lang.String serviceId,
                                          java.lang.String regName,
                                          java.lang.String gateHost,
                                          int gatePort)

registerAppServer

public java.lang.String registerAppServer(java.lang.String serviceId,
                                          java.lang.String regName,
                                          java.lang.String gateHost,
                                          int gatePort,
                                          boolean isPrivateNetwork)

앱서버를 등록 및 구동한다. 최초 앱서버 등록시 뿐 아니라 이후에도 앱서버 재구동시마다 호출하여 라이브러리가 구동하도록 해야 한다. setRegisterResultListener()로 등록한 AppServerRegisterResultListener의 콜백을 통해 등록 결과를 확인한다. 앱서버 등록 결과는 래셔널아울 콘솔에서도 실시간 확인이 가능하다.

Parameters:

serviceId - 앱서버가 등록할 대상 고객 서비스의 서비스 아이디

regName - 앱서버 등록 이름으로 래셔널아울 서비스의 관리자 콘솔에 표시되는 고객 서버의 이름 콘솔에서 앱 서버를 구분하는 역할을 한다.

gateHost - 고객 앱 서버와 가장 가까운 래셔널아울 게이트서버(ex) seoul1.rationalowl.com

gatePort - 게이트서버의 포트 고객 앱 서버와 가장 가까운 래셔널아울 게이트서버(ex) seoul1.rationalowl.com

isPrivateNetwork - 앱서버가 메시징 서버와 같은 사설망에서 운영될 경우 true

Returns:

request id

unregisterAppServer

public java.lang.String unregisterAppServer(java.lang.String serviceId,
                                            java.lang.String serverRegId)

앱서버를 등록해제한다. setRegisterResultListener()로 등록한 AppServerRegisterResultListener의 콜백을 통해 등록 헤제 결과를 확인한다. 앱서버 등록 해제 결과는 래셔널아울 콘솔에서도 실시간 확인이 가능하다.

Parameters:

serviceId - 앱서버가 등록된 고객 서비스의 서비스 아이디

serverRegId - 등록해제할 앱서버 등록 아이디

Returns:

request id

createDeviceGroup

public java.lang.String createDeviceGroup(java.lang.String groupName,
                                          java.lang.String groupDesc,
                                          java.util.ArrayList<java.lang.String> deviceList)

단말 그룹을 생성한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

groupName - 생성할 단말 그룹명

groupDesc - 단말 그룹에 대한 설명 - optional 필드로 null입력가능

deviceList - 단말 그룹 생성시 그룹 내 포함시킬 단말 목록 최대 2000단말 목록까지 포함가능

Returns:

request id

addDeviceGroup

public java.lang.String addDeviceGroup(java.lang.String groupId,
                                       java.util.ArrayList<java.lang.String> deviceList)

단말 그룹에 단말을 추가한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

groupId - 대상 단말 그룹 아이디

deviceList - 단말 그룹에 추가할 단말 목록 한번에 최대 2000단말 목록까지 포함가능 단말 그룹 내 단말 수는 최대 백만 대까지 포함 가능

Returns:

request id

subtractDeviceGroup

public java.lang.String subtractDeviceGroup(java.lang.String groupId,
                                            java.util.ArrayList<java.lang.String> deviceList)

단말 그룹에서 단말을 제거한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

groupId - 대상 단말 그룹 아이디

deviceList - 단말 그룹에서 제거할 단말 목록 한번에 최대 2000단말 목록까지 포함가능

Returns:

request id

deleteDeviceGroup

public java.lang.String deleteDeviceGroup(java.lang.String groupId)

단말 그룹을 삭제한다. setDeviceGroupListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

groupId - 대상 단말 그룹 아이디

Returns:

request id

sendMulticastMsg

public java.lang.String sendMulticastMsg(java.lang.String data,
                                         java.util.ArrayList<java.lang.String> deviceRegIds)

한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 기본 큐잉 지원. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

deviceRegIds - 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한

Returns:

request id

sendMulticastMsg

public java.lang.String sendMulticastMsg(java.lang.String data,
                                         java.util.ArrayList<java.lang.String> deviceRegIds,
                                         boolean supportMsgQ,
                                         java.lang.String notiTitle,
                                         java.lang.String notiBody)

한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

deviceRegIds - 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한

supportMsgQ - 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.

notiTitle - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자

notiBody - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

Returns:

request id

sendMulticastMsg

public java.lang.String sendMulticastMsg(java.lang.String data,
                                         java.util.ArrayList<java.lang.String> deviceRegIds,
                                         boolean supportMsgQ,
                                         java.lang.String notiTitle,
                                         java.lang.String notiBody,
                                         java.lang.String notiSound)

한대 이상의 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

deviceRegIds - 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한

supportMsgQ - 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.

notiTitle - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자

notiBody - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

notiSound - 알림음 (ex: "my_custom_sound.wav")

Returns:

request id

sendMulticastCustomPush

public java.lang.String sendMulticastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                                java.util.ArrayList<java.lang.String> deviceRegIds)

한대 이상의 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

deviceRegIds - 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한

Returns:

request id

sendMulticastCustomPush

public java.lang.String sendMulticastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                                java.util.ArrayList<java.lang.String> deviceRegIds,
                                                boolean isSilentPush)

한대 이상의 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

deviceRegIds - 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한

isSilentPush - 사일런트 푸시 여부 false: 부, true: 사일런트 푸시

Returns:

request id

sendMulticastCustomPush

public java.lang.String sendMulticastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                                java.util.ArrayList<java.lang.String> deviceRegIds,
                                                boolean isSilentPush,
                                                boolean encryptSet)

한대 이상의 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

deviceRegIds - 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한

isSilentPush - 사일런트 푸시 여부 false: 부, true: 사일런트 푸시

encryptSet - 메시지 암호화 여부 false: 비암호화, true: 암호화

Returns:

request id

sendBroadcastMsg

public java.lang.String sendBroadcastMsg(java.lang.String data)

고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 기본 큐잉 지원. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

Returns:

request id

sendBroadcastMsg

public java.lang.String sendBroadcastMsg(java.lang.String data,
                                         boolean supportMsgQ,
                                         java.lang.String notiTitle,
                                         java.lang.String notiBody)

고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

supportMsgQ - 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.

notiTitle - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자

notiBody - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

Returns:

request id

sendBroadcastMsg

public java.lang.String sendBroadcastMsg(java.lang.String data,
                                         boolean supportMsgQ,
                                         java.lang.String notiTitle,
                                         java.lang.String notiBody,
                                         java.lang.String notiSound)

고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

supportMsgQ - 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.

notiTitle - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자

notiBody - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

notiSound - 알림음 (ex: "my_custom_sound.wav")

Returns:

request id

sendBroadcastCustomPush

public java.lang.String sendBroadcastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data)

모든 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

Returns:

request id

sendBroadcastCustomPush

public java.lang.String sendBroadcastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                                boolean isSilentPush)

모든 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

isSilentPush - 사일런트 푸시 여부 false: 부, true: 사일런트 푸시

Returns:

request id

sendBroadcastCustomPush

public java.lang.String sendBroadcastCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                                boolean isSilentPush,
                                                boolean encryptSet)

모든 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

isSilentPush - 사일런트 푸시 여부 false: 부, true: 사일런트 푸시

encryptSet - 메시지 암호화 여부 false: 비암호화, true: 암호화

Returns:

request id

sendGroupMsg

public java.lang.String sendGroupMsg(java.lang.String data,
                                     java.lang.String deviceGroupId)

단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 기본 큐잉 지원. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

deviceGroupId - 단말 그룹 아이디

Returns:

request id

sendGroupMsg

public java.lang.String sendGroupMsg(java.lang.String data,
                                     java.lang.String deviceGroupId,
                                     boolean supportMsgQ,
                                     java.lang.String notiTitle,
                                     java.lang.String notiBody)

단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

deviceGroupId - 단말 그룹 아이디

supportMsgQ - 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.

notiTitle - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자

notiBody - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

Returns:

request id

sendGroupMsg

public java.lang.String sendGroupMsg(java.lang.String data,
                                     java.lang.String deviceGroupId,
                                     boolean supportMsgQ,
                                     java.lang.String notiTitle,
                                     java.lang.String notiBody,
                                     java.lang.String notiSound)

단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. setMsgListener로 등록한 리스너의 콜백을 통해 결과를 확인한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.

Parameters:

data - 단말에 전달할 데이터

deviceGroupId - 단말 그룹 아이디

supportMsgQ - 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.

notiTitle - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자

notiBody - 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자

notiSound - 알림음 (ex: "my_custom_sound.wav")

Returns:

request id

sendGroupCustomPush

public java.lang.String sendGroupCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                            java.lang.String deviceGroupId)

단말 그룹에 등록된 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

deviceGroupId - 단말 그룹 아이디

Returns:

request id

sendGroupCustomPush

public java.lang.String sendGroupCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                            java.lang.String deviceGroupId,
                                            boolean isSilentPush)

단말 그룹에 등록된 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

deviceGroupId - 단말 그룹 아이디

isSilentPush - 사일런트 푸시 여부 false: 부, true: 사일런트 푸시

Returns:

request id

sendGroupCustomPush

public java.lang.String sendGroupCustomPush(java.util.Map<java.lang.String,java.lang.Object> data,
                                            java.lang.String deviceGroupId,
                                            boolean isSilentPush,
                                            boolean encryptSet)

단말 그룹에 등록된 단말앱에 이미지 푸시와 같은 커스터마이징 가능한 푸시 메시지를 발신한다. 마케팅/광고/금융정보 앱 과 같은 특화된 푸시 알림에 최적화된 API이다. 래셔널아울 콘솔에서 메시지 전달 실시간 모니터링이 가능하다. 메시지 수신확인 뿐 아니라 알림 전달 여부도 모니터링에 포함된다. 래셔널아울 메시징 서버에서 제공하는 큐잉은 기본으로 지원한다.

Parameters:

data - : 사용자가 전달하고자 하는 json 포맷의 키/값 쌍의 json 데이터만 지원한다. ex) { "myNotiTitle":"it's my custom noti title", "myNotiBody":"it's my custom noti body!", "imageUrl":"http://myimage.com/image1.jpg", "soundUrl":"http://mysound.com/sound1.mp3" }

deviceGroupId - 단말 그룹 아이디

isSilentPush - 사일런트 푸시 여부 false: 부, true: 사일런트 푸시

encryptSet - 메시지 암호화 여부 false: 비암호화, true: 암호화

Returns:

request id

retryCustomPush

public java.lang.String retryCustomPush(java.lang.String msgId,
                                        int retryOption)

커스텀 푸시 발신 API로 발신한 메시지 중 미전달 큐잉 혹은 메시지 미확인 단말들에게 재 발송한다.

Parameters:

msgId: - 기존 커스텀 푸시 메시지 ID

retryOption - 1: 미전달 큐잉된 단말 대상 재 발신 2: 미전달 큐잉 및 메시지 미확인 단말 대상 재 발신

Returns:

request id

msgStatsTracking

public java.lang.String msgStatsTracking(java.util.ArrayList<java.lang.String> msgIds)

메시지 전달 통계 데이터를 실시간 확인한다.

Parameters:

msgIds - 메시지 전달 통계를 알고자 하는 메시지 아이디 목록

Returns:

request id

msgDevicesTracking

public java.lang.String msgDevicesTracking(java.lang.String msgId,
                                           int msgStateFlag,
                                           int deviceTypeFlag,
                                           int startIndex,
                                           int fetchSize)

메시지 상태별 단말앱 목록을 실시간 확인한다. 가장 일반적인 사용예는 알림 미전달 대상 단말앱 목록에 유료 메시지 발신하고자 할 경우이다.

Parameters:

msgId - 트래킹하고자 하는 메시지 아이디

msgStateFlag - : 아래 값들의 bit or 값 0: all 1: 큐잉된 단말앱 목록을 fetch한다. 2: 수신확인한 단말앱 목록을 fetch한다. 4: 메시지 미전달 기한만료된 단말앱 목록을 fetch한다. 8: 알림전달한 단말앱 목록을 fetch한다.

deviceTypeFlag - : 아래 값들의 bit or 값 0: all 1: 안드로이드 단말앱 목록을 fetch한다. 2: IOS 단말앱 목록을 fetch한다.

startIndex - 전체 단말앱 중 fetch 시작 index

fetchSize - 전체 단말앱 목록 startIndex부터 fetch할 단말앱 목록 수

Returns:

request id

msgDeviceDetailTracking

public java.lang.String msgDeviceDetailTracking(java.lang.String msgId,
                                                int msgStateFlag,
                                                int deviceTypeFlag,
                                                int startIndex,
                                                int fetchSize)

메시지 상태별 단말앱 상세정보를 실시간 확인한다.

Parameters:

msgId - 트래킹하고자 하는 메시지 아이디

msgStateFlag - : 아래 값들의 bit or 값 0: all 1: 큐잉된 단말앱 목록을 fetch한다. 2: 수신확인한 단말앱 목록을 fetch한다. 4: 메시지 미전달 기한만료된 단말앱 목록을 fetch한다. 8: 알림전달한 단말앱 목록을 fetch한다.

deviceTypeFlag - : 아래 값들의 bit or 값 0: all 1: 안드로이드 단말앱 목록을 fetch한다. 2: IOS 단말앱 목록을 fetch한다.

startIndex - 전체 단말앱 중 fetch 시작 index

fetchSize - 전체 단말앱 목록 startIndex부터 fetch할 단말앱 목록 수

Returns:

request id

batchMsgDevicesTracking

public java.lang.String batchMsgDevicesTracking(java.util.ArrayList<java.lang.String> msgIds,
                                                int msgStateFlag)

다수의 메시지 상태별 단말앱 목록을 실시간 확인한다. 대상 단말이 1~2대인 개인화된 메시지의 트래킹 정보를 고속으로 처리하고자 할때 사용한다. 전체 메시지의 대상 단말앱 수가 1000개를 넘어서는 안된다. 대상 단말앱수가 과다할 경우 배치 API 대신 일반 msgDevicesTracking API를 이용해야 한다. 가장 일반적인 사용예는 알림 미전달 대상 단말앱 목록에 유료 메시지 발신하고자 할 경우이다.

Parameters:

msgIds - 메시지 상태별 단말아이디 목록을 알고자 하는 메시지 아이디 목록 메시지 아이디 목록은 최대 100개까지 지원한다.

msgStateFlag - : 아래 값들의 bit or 값 0: all 1: 큐잉된 단말앱 목록을 fetch한다. 2: 수신확인한 단말앱 목록을 fetch한다. 4: 메시지 미전달 기한만료된 단말앱 목록을 fetch한다. 8: 알림전달한 단말앱 목록을 fetch한다.

Returns:

request id

batchMsgDeviceDetailTracking

public java.lang.String batchMsgDeviceDetailTracking(java.util.ArrayList<java.lang.String> msgIds,
                                                     int msgStateFlag)

다수의 메시지 상태별 단말앱 상세 정보를 실시간 확인한다. 대상 단말이 1~2대인 개인화된 메시지의 트래킹 정보를 고속으로 처리하고자 할때 사용한다. 전체 메시지의 대상 단말앱 수가 1000개를 넘어서는 안된다. 대상 단말앱수가 과다할 경우 배치 API 대신 일반 msgDeviceDetailTracking API를 이용해야 한다.

Parameters:

msgIds - 메시지 상태별 단말아이디 목록을 알고자 하는 메시지 아이디 목록 메시지 아이디 목록은 최대 100개까지 지원한다.

msgStateFlag - : 아래 값들의 bit or 값 0: all 1: 큐잉된 단말앱 목록을 fetch한다. 2: 수신확인한 단말앱 목록을 fetch한다. 4: 메시지 미전달 기한만료된 단말앱 목록을 fetch한다. 8: 알림전달한 단말앱 목록을 fetch한다.

Returns:

request id

setAutoMsgTracking

public java.lang.String setAutoMsgTracking(boolean set)

unregisterDevices

public java.lang.String unregisterDevices(java.util.ArrayList<java.lang.String> deviceIds)

단말 그룹을 삭제한다. 결과는 setDeviceSyncListener로 등록한 DeviceSyncListener의 onDevicesUnregisterResult 콜백을 통해 결과를 확인한다.

Parameters:

deviceIds - 등록 해제할 단말 아이디 목록

Returns:

request id

getDeviceIds

public java.lang.String getDeviceIds(int startIndex,
                                     int fetchSize)

서비스 내 유효한 단말앱 아이디 목록을 요청한다. 결과는 setDeviceSyncListener로 등록한 DeviceSyncListener의 onDeviceIdResult 콜백을 통해 확인한다.

Parameters:

startIndex - 전체 단말앱 중 fetch 시작 index

fetchSize - 전체 단말앱 목록 startIndex부터 fetch할 단말앱 아이디 목록 수

Returns:

request id

getSynchronizedGroupDeviceIds

public java.lang.String getSynchronizedGroupDeviceIds(java.lang.String deviceGroupId,
                                                      int startIndex,
                                                      int fetchSize)

본 API가 호출되면 단말 그룹 내 동기화 작업이 수행되고 단말그룹내 내 유효한 단말앱 아이디 목록이 콜백으로 전달된다. 결과는 setDeviceSyncListener로 등록한 DeviceSyncListener의 onGroupDeviceIdResult 콜백을 통해 확인한다.

Parameters:

deviceGroupId - 대상 단말그룹 아이디

startIndex - 전체 단말앱 중 fetch 시작 index

fetchSize - 전체 단말앱 목록 startIndex부터 fetch할 단말앱 아이디 목록 수

Returns:

request id

initAppServer

public void initAppServer()

uploadFile

public java.lang.String uploadFile(java.nio.file.Path filePath)

파일을 파일 스토리지에 업로드한다. setFileStorageListener()로 등록한 FileStorageListener의 콜백을 통해 업로드 진행률과 업로드 결과를 확인한다.

Parameters:

filePath - 업로드할 파일의 패스

Returns:

request id

downloadFile

public java.lang.String downloadFile(java.lang.String fileId,
                                     java.nio.file.Path filePath)

파일스토리지서버에서 파일을 다운로드하여 로컬 파일경로에 저장한다. setFileStorageListener()로 등록한 FileStorageListener의 콜백을 통해 다운로드 진행률과 다운로드 결과를 확인한다.

Parameters:

fileId - 다운로드할 파일의 아이디

filePath - 다운로드한 파일을 저장할 파일 패스

Returns:

request id