|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@UciService(value="ucp.v30.requests.fax")
@RpcInterface(value="ucp.v30.requests.fax")
@RpcValueTranslation(version=30,
automaticFileTransfer=true)
public interface UciFaxRequestsThis interface contains the UCI Communication Fax Requests
| Method Summary | |
|---|---|
List<String> |
getFaxIds()
The UCI client may call getFaxIds to have the server send a response with a list of fax ids of the faxes being sent by the user. |
Fax |
getFaxState(String faxId)
The getFaxState message is used to query STARFACE for the state of an identified fax request. |
String |
sendFax(String faxNumber,
String faxId,
File textFile,
File pdfFile)
This procedure is called to initiate a fax sending process. |
void |
sendFaxAsync(String faxNumber,
String faxId,
File textFile,
File pdfFile)
This procedure is called to initiate a fax sending process. |
| Method Detail |
|---|
List<String> getFaxIds()
throws UciException
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if the request is not allowed to the user (UciIllegalAccessException) or if
the request is placed while the UCI client is not connected (
UcpNotConnectedException).
Fax getFaxState(String faxId)
throws UciException
faxId - the UUID assigned to the fax request
Map. The constants of
FaxProperties are used as keys in the map. If the fax is not known an empty
dictionary is returned.
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 sendFax(String faxNumber,
String faxId,
File textFile,
File pdfFile)
throws UciException
UciFaxEvents.
faxNumber - the phone number to dialfaxId - The UUID to be assigned to the fax request. If not set STARFACE will create one.textFile - the text file containing the fax as plain text. This file is optional.pdfFile - the PDF file containing the PDF to be sent as fax.
String if the fax request was rejected by the server or the UUID
assigned to the fax request otherwise
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 sendFaxAsync(String faxNumber,
String faxId,
File textFile,
File pdfFile)
throws UciException
FileTransferEventListener can be registered with the RpcRequestCaller used to
make the call. To obtain information about the ongoing fax sending process a client may
subscribe to the UciFaxEvents.
faxNumber - the phone number to dialfaxId - The UUID to be assigned to the fax request. If not set STARFACE will create one.textFile - the text file containing the fax as plain text. This file is optional.pdfFile - the PDF file containing the PDF to be sent as fax.
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 | |||||||||