de.starface.integration.uci.java.v30.ucp.messages.requests
Interface UcpMonitorListRequests


@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

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

getMonitorList

Map<String,Object> getMonitorList(Date startAfter,
                                  Date startBefore,
                                  String orderProperty,
                                  String orderDirection,
                                  int countOffset,
                                  int countLimit)
                                  throws UciException
With this request the UCI client can 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 Map containing the values for the keys defined in MonitorListProperties.

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 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 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 Map containing the results with the properties defined in MonitorListProperties
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
This request allows the UCI client to 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
This request allows the UCI client to 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
This request 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

String getMonitorFile(String monitorId)
                      throws UciException
Prepares the download of the monitor for the given monitor id. After a calling this request the file can be downloaded using the interface UcpMonitorListRequests.MonitorFileDownload and the returned fileId.

Parameters:
monitorId - the id of the monitor list entry to retrieve the file for
Returns:
the fileId that can be used to download the file from STARFACE
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.