de.starface.integration.uci.java.v30.messages.requests
Interface UciMonitorListRequests


@UciService(value="ucp.v30.requests.monitorList")
@RpcInterface(value="ucp.v30.requests.monitorList")
@RpcValueTranslation(version=30,
                     automaticFileTransfer=true)
public interface UciMonitorListRequests

This 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

getMonitorList

MonitorList getMonitorList(Date startAfter,
                           Date startBefore,
                           MonitorListEntryProperties orderProperty,
                           OrderDirection orderDirection,
                           int countOffset,
                           int countLimit)
                           throws UciException
Retrieve a list of monitors of the current user. The number of entries retrieved can be restricted by several parameters of this procedure call. The results are returned as List of Map containing the values for the keys defined in MonitorListEntryProperties.

Parameters:
startBefore - limit returned results to monitors started before the given point of time
startAfter - limit returned results to monitors started after the given point of time
orderProperty - 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 used
countOffset - the offset of the first returned value in the result list after the ordering has been applied
countLimit - the count of items returned in the result list
Returns:
a List containing the result elements
Throws:
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).

deleteMonitorListEntry

void deleteMonitorListEntry(String monitorId)
                            throws UciException
Remove a monitor list entry from the list

Parameters:
monitorId - the id of the monitor list entry to remove
Throws:
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).

deleteMonitorListEntries

void deleteMonitorListEntries(List<String> monitorIds)
                              throws UciException
Remove multiple monitor list entries from the list

Parameters:
monitorIds - the ids of the monitor list entries to remove
Throws:
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).

getMonitorFileUrl

String getMonitorFileUrl(String monitorId)
                         throws UciException
Creates and returns a temporary URL that can be used to download the monitor file for the next 15 minutes.

Parameters:
monitorId - the id of the monitor list entry to retrieve the file for
Returns:
The download URL as String
Throws:
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).

getMonitorFile

File getMonitorFile(String monitorId)
                    throws UciException
Downloads and returns the monitor for the given monitor id

Parameters:
monitorId - the id of the monitor list entry to retrieve the file for
Returns:
the monitor file
Throws:
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).


Copyright © 2012 STARFACE GmbH. All rights reserved.