|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@RpcInterface(value="ucp.v30.requests.fax") @UciService(value="ucp.v30.requests.fax") public interface UcpFaxRequests
This interface defines the fax requests provided by the UCI server.
| Nested Class Summary | |
|---|---|
static interface |
UcpFaxRequests.SendFaxFileUpload
This interface defines the RPC methods that can be used to upload the fax files |
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| 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 currently being sent by the user. |
Map<String,Object> |
getFaxState(String faxId)
The getFaxState request is used to query the UCI server for the state of an identified fax request. |
String |
sendFax(String faxNumber,
String faxId,
String textFileId,
String pdfFileId)
This request initiates the fax sending process. |
| Field Detail |
|---|
static final String SERVICE_NAME
| 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 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).
Map<String,Object> 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 to
STARFACE an empty Map 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,
String textFileId,
String pdfFileId)
throws UciException
UcpFaxRequests.SendFaxFileUpload RPC interface. In the next step sendFax can be
invoked and the destination number of the fax must be given. In UCI faxes are identified
using UUIDs (Universally Unique Identifier). The id for the fax to be sent can either be
given by the client or generated by STARFACE. In the case of a successful response (denoted
by a non empty returned value), the fax sending process has been started. However the fax has
not actually been sent to the destination yet.
faxNumber - the phone number to send the fax tofaxId - The UUID to be assigned to the fax request. If not set STARFACE will create one.textFileId - the id of the file transfer used to upload the text file. If no text file has been
uploaded the empty string must be given.pdfFileId - the id of the file transfer used to upload the PDF file.
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 | |||||||||