|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.monitorList")
@RpcInterface(value="ucp.v30.requests.monitorList")
@RpcValueTranslation(version=30,
automaticFileTransfer=true)
public interface UciMonitorListRequestsThis interface contains the UCI Communication Voicemail List Requests
| Method Summary | |
|---|---|
void |
deleteMonitorListEntries(List<String> monitorIds)
Remove multiple monitor list entries from the list |
void |
deleteMonitorListEntry(String monitorId)
Remove a monitor list entry from the list |
File |
getMonitorFile(String monitorId)
Downloads and returns the monitor for the given monitor id |
String |
getMonitorFileUrl(String monitorId)
Creates and returns a temporary URL that can be used to download the monitor file for the next 15 minutes. |
MonitorList |
getMonitorList(Date startAfter,
Date startBefore,
MonitorListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
Retrieve a list of monitors of the current user. |
| Method Detail |
|---|
MonitorList getMonitorList(Date startAfter,
Date startBefore,
MonitorListEntryProperties orderProperty,
OrderDirection orderDirection,
int countOffset,
int countLimit)
throws UciException
List of Map containing the values for the keys defined in
MonitorListEntryProperties.
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 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 null or an invalid property is
given the default MonitorListEntryProperties.monitortimestart is used.orderDirection - give one of the OrderDirections to define the ordering. If null is given 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
List containing the result elements
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).
File getMonitorFile(String monitorId)
throws UciException
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 | |||||||||