|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@RpcInterface(value="ucp.v30.requests.monitorList") @UciService(value="ucp.v30.requests.monitorList") public interface UcpMonitorListRequests
This interface defines the monitor list requests provided by the UCI server.
| Nested Class Summary | |
|---|---|
static interface |
UcpMonitorListRequests.MonitorFileDownload
This interface defines the RPC methods that can be used to download the voicemail files |
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| Method Summary | |
|---|---|
void |
deleteMonitorListEntries(List<String> monitorIds)
This request allows the UCI client to remove multiple monitor list entries from the list |
void |
deleteMonitorListEntry(String monitorId)
This request allows the UCI client to remove a monitor list entry from the list |
String |
getMonitorFile(String monitorId)
Prepares the download of the monitor for the given monitor id. |
String |
getMonitorFileUrl(String monitorId)
This request creates and returns a temporary URL that can be used to download the monitor file for the next 15 minutes. |
Map<String,Object> |
getMonitorList(Date startAfter,
Date startBefore,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
With this request the UCI client can retrieve a list of monitors of the current user. |
| Field Detail |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
Map<String,Object> getMonitorList(Date startAfter,
Date startBefore,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
throws UciException
Map containing the values for the keys defined in
MonitorListProperties.
startBefore - limit returned results to monitors started before the given point of timestartAfter - limit returned results to monitors started after the given point of timeorderProperty - give the name of one of the MonitorListEntryProperties to order results by the
value of the property. Allowed values are
MonitorListEntryProperties.monitortimestart ,
MonitorListEntryProperties.duration,
MonitorListEntryProperties.callercallerid and
MonitorListEntryProperties.calledcallerid. When an empty String or invalid
property name is given the default MonitorListEntryProperties.monitortimestart
is used.orderDirection - give the name of one of the OrderDirections to define the ordering. If not set
the default order direction of the property will be usedcountOffset - the offset of the first returned value in the result list after the ordering has been
appliedcountLimit - the count of items returned in the result list
Map containing the results with the properties defined in
MonitorListProperties
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void deleteMonitorListEntry(String monitorId)
throws UciException
monitorId - the id of the monitor list entry to remove
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void deleteMonitorListEntries(List<String> monitorIds)
throws UciException
monitorIds - the ids of the monitor list entries to remove
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
String getMonitorFileUrl(String monitorId)
throws UciException
monitorId - the id of the monitor list entry to retrieve the file for
String
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
String getMonitorFile(String monitorId)
throws UciException
UcpMonitorListRequests.MonitorFileDownload and the returned
fileId.
monitorId - the id of the monitor list entry to retrieve the file for
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||