Module: AppServerManager

A module that says hello!
Source:

Methods

(inner) addDeviceGroup(groupId, deviceList) → {Promise}

단말 그룹에 단말을 추가한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Description
groupId string 대상 단말 그룹 아이디
deviceList Array.<string> 단말 그룹에 추가할 단말 목록 한번에 최대 2000단말 목록까지 포함가능 단말 그룹 내 단말 수는 최대 백만 대까지 포함 가능
Source:
Returns:
단말 추가에 대한 응답을 Promise로 리턴
Type
Promise

(inner) addReceivedUpstreamMsgListener(listener)

업스트림 메시지에 대한 응답을 받기 위해 리스너를 등록한다.
Parameters:
Name Type Description
listener UpstreamMessageListenerType 콜백 리스너
Source:

(inner) createDeviceGroup(groupName, groupDesc, deviceList) → {Promise}

단말 그룹을 생성한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Description
groupName string 생성할 단말 그룹명
groupDesc string 단말 그룹에 대한 설명 - optional 필드로 null입력가능
deviceList Array.<string> 단말 그룹 생성시 그룹 내 포함시킬 단말 목록 최대 2000단말 목록까지 포함가능
Source:
Returns:
단말그룹 생성에 대한 응답을 Promise로 리턴
Type
Promise

(inner) deleteDeviceGroup(groupId) → {Promise}

단말 그룹을 삭제한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Description
groupId string 대상 단말 그룹 아이디
Source:
Returns:
단말 그룹 제거에 대한 응답을 Promise로 리턴
Type
Promise

(inner) removeReceivedUpstreamMsgListener(listener)

등록한 리스너를 제거한다.
Parameters:
Name Type Description
listener UpstreamMessageListenerType 제거할 콜백 리스너
Source:

(inner) sendBroadcastMsg(data, supportMsgQ, notiTitleopt, notiMsgopt) → {Promise}

고객 서비스에 등록된 모든 단말앱에 다운스트림 메시지를 발신한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Attributes Default Description
data string 단말에 전달할 데이터
supportMsgQ boolean 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.
notiTitle string <optional>
 null 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자
notiMsg string <optional>
 null 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자
Source:
Returns:
보낸 메시지에 대한 응답을 Promise로 리턴
Type
Promise

(inner) sendGroupMsg(data, deviceGroupId, supportMsgQ, notiTitleopt, notiMsgopt) → {Promise}

단말 그룹에 등록된 단말앱에 다운스트림 메시지를 발신한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Attributes Default Description
data string 단말에 전달할 데이터
deviceGroupId string 단말 그룹 아이디
supportMsgQ boolean 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.
notiTitle string <optional>
 null 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자
notiMsg string <optional>
 null 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자
Source:
Returns:
보낸 메시지에 대한 응답을 Promise로 리턴
Type
Promise

(inner) sendMulticastMsg(data, deviceRegIds, supportMsgQ, notiTitleopt, notiMsgopt) → {Promise}

한대 이상의 단말앱에 다운스트림 메시지를 발신한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Attributes Default Description
data string 단말에 전달할 데이터
deviceRegIds Array.<string> 메시지를 전달할 대상 단말앱의 단말 등록 아이디 목록 최대 2000 단말 목록 제한
supportMsgQ boolean 메시지 큐잉 지원 여부 true일 경우 단말이 전원꺼짐 등의 이유로 데이터통신이 불가할 경우 기본 3일 동안 래셔널아울 메시징 서버가 보관하다가 3일 이내 단말이 네트워크에 연결될 때 미전달 메시지를 전달한다.
notiTitle string <optional>
 null 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 타이틀로 표시할 문자
notiMsg string <optional>
 null 알림 용도로 메시지 전달 시 단말앱이 비활성시 알림 내용으로 표시할 문자
Source:
Returns:
보낸 메시지에 대한 응답을 Promise로 리턴
Type
Promise

(inner) subtractDeviceGroup(groupId, deviceList) → {Promise}

단말 그룹에서 단말을 제거한다. 래셔널아울 콘솔에서도 실시간 결과 확인이 가능하다.
Parameters:
Name Type Description
groupId string 대상 단말 그룹 아이디
deviceList Array.<string> 단말 그룹에서 제거할 단말 목록 한번에 최대 2000단말 목록까지 포함가능
Source:
Returns:
단말 제거에 대한 응답을 Promise로 리턴
Type
Promise

(inner) unregisterAppServer(serviceId, serverRegId) → {Promise}

앱서버를 등록해제한다. 앱서버 등록 해제 결과는 래셔널아울 콘솔에서도 실시간 확인이 가능하다.
Parameters:
Name Type Description
serviceId string 앱서버가 등록된 고객 서비스의 서비스 아이디
serverRegId string 등록해제할 앱서버 등록 아이디
Source:
Returns:
앱 서버 등록해제에 대한 응답을 Promise로 리턴
Type
Promise