|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.callList") @RpcInterface(value="ucp.v30.requests.callList") public interface UcpCallListRequests
This interface defines the call list requests provided by the UCI server.
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| Method Summary | |
|---|---|
void |
deleteCallListEntries(List<String> callIds)
Remove multiple call list entries from the list |
void |
deleteCallListEntry(String callId)
Remove a call list entry from the list |
Map<String,Object> |
getCallList(Date startBefore,
Date startAfter,
String directionRestriction,
String resultRestriction,
String groupRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
Retrieve a list of phone calls of the current user. |
String |
placeCallbackCallWithPhone(String callListEntryId,
String phoneId,
String callId)
This request is called to initiate a phone call for the user the same way as when using the STARFACE call list. |
| Field Detail |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
Map<String,Object> getCallList(Date startBefore,
Date startAfter,
String directionRestriction,
String resultRestriction,
String groupRestriction,
String orderProperty,
String orderDirection,
int countOffset,
int countLimit)
throws UciException
Map
containing the values for the keys defined in CallListProperties.
startBefore - limit returned results to calls started before the given point of timestartAfter - limit returned results to calls started after the given point of timedirectionRestriction - restrict returned results to calls of the given CallListEntryDirection. If an
empty String is given no restriction is used.resultRestriction - restrict returned results to calls of the given CallListEntryResult. If an
empty String is given no restriction is used.groupRestriction - restrict returned results to those conducted by a specified group. Possible choices
are the String GroupRestriction.NON_GROUP to return all calls that do not
belong to any group, the id of a group to restrict the list to the calls belonging to
that group and the empty String to return all calls without restriction.orderProperty - give the name of one of the CallListEntryProperties to order results by the
value of the property. Allowed values are CallListEntryProperties.startTime,
CallListEntryProperties.duration, CallListEntryProperties.callerNumber
and CallListEntryProperties.calledNumber. When an empty String or invalid
property name is given the default CallListEntryProperties.startTime 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
CallListProperties
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 deleteCallListEntry(String callId)
throws UciException
callId - the id of the call 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 deleteCallListEntries(List<String> callIds)
throws UciException
callIds - the ids of the call 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 placeCallbackCallWithPhone(String callListEntryId,
String phoneId,
String callId)
throws UciException
CallState.OUTGOING.
callListEntryId - The identification of the call list entry.phoneId - The id of the telephone used to make the phone call. If not set the primary phone will
be used.callId - The UUID to be assigned to the phone call. If not set STARFACE will create one.
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 | |||||||||