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


@RpcInterface(value="ucp.v30.events.fax")
@UciService(value="ucp.v30.events.fax")
public interface UcpFaxEvents

This interface defines fax events that can be received by a UCI client implementation in order to handle outgoing faxes.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 void receiveFaxState(Map<String,Object> faxProperties)
          Much the same as UcpCallEvents.receiveCallState(Map) the ReceiveFaxState event notifies the UCI client of state changes of an outgoing fax request by providing several properties about the fax request including the id of the fax request, the new state of the fax request and the timestamp when the request did change its state.
 

Field Detail

SERVICE_NAME

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

See Also:
Constant Field Values
Method Detail

receiveFaxState

void receiveFaxState(Map<String,Object> faxProperties)
Much the same as UcpCallEvents.receiveCallState(Map) the ReceiveFaxState event notifies the UCI client of state changes of an outgoing fax request by providing several properties about the fax request including the id of the fax request, the new state of the fax request and the timestamp when the request did change its state. The state FaxState.WAITING is never signaled by the server. It is assumed after a successful call to UcpFaxRequests.sendFax(String, String, String, String).

Parameters:
faxProperties - the different properties of the fax in a Map. The constants of FaxProperties are used as keys in the map.


Copyright © 2012 STARFACE GmbH. All rights reserved.