de.starface.integration.uci.java.v30.ucp.messages.events
Interface UcpCallEvents


@RpcInterface(value="ucp.v30.events.call")
@UciService(value="ucp.v30.events.call")
public interface UcpCallEvents

This interface defines the call events that can be received by a UCI client implementation in order to handle phone calls.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 void callChangesIdEvent(Map<String,Object> callIdChangesEvent)
          This event provides Information about the new callId of a call to the UCI client
 void newMessageWaitingIndicationEvent(Map<String,Object> messageWaitingIndicationInfo)
          This event provides Information about new VoicemailMessages to the UCI client
 void receiveCallState(Map<String,Object> callProperties)
          The ReceiveCallState event provides a number of properties about the call the state is changing of.
 

Field Detail

SERVICE_NAME

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

See Also:
Constant Field Values
Method Detail

receiveCallState

void receiveCallState(Map<String,Object> callProperties)
The ReceiveCallState event provides a number of properties about the call the state is changing of. The information provided in the map is defined by its properties as seen in CallProperties. If a name or number is not known to STARFACE an empty string is committed for that property. It is possible that information about the caller or the called person gets available in the middle of a series of events so that the first call state events don’t provide any details but later events contain full participant information. The sequential change of the CallProperties.state property adheres to the state diagram given in the UCI specification. It is assumed after a successful return of the UcpCallRequests.placeCallWithPhone(String, String, String) request.

Parameters:
callProperties - the different properties of the call in a Map. The constants of CallProperties are used as keys in the map.

newMessageWaitingIndicationEvent

void newMessageWaitingIndicationEvent(Map<String,Object> messageWaitingIndicationInfo)
This event provides Information about new VoicemailMessages to the UCI client

Parameters:
messageWaitingIndicationInfo - the new messageWaitingIndication MessageWaitingIndicationInfo

callChangesIdEvent

void callChangesIdEvent(Map<String,Object> callIdChangesEvent)
This event provides Information about the new callId of a call to the UCI client

Parameters:
callIdChangesEvent - the callChangesIdEvent CallIdChanges


Copyright © 2012 STARFACE GmbH. All rights reserved.