|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.efaxdeveloper.util.outbound.StatusRequest
public class StatusRequest
StatusRequest application interface
Overview
The StatusRequest application interface is used to send outbound status requests to
eFax Developer™.The following snippet provides a basic example of how the StatusRequest application interface might be used to send an outbound status request to eFax Developer™:
// Instantiate a new StatusRequest object StatusRequest req = new StatusRequest(); // Set your eFax Developer outbound account identifier (required) req.setAccountID("1234567890"); // Set your eFax Developer outbound user name (required) req.setUserName("joe"); // Set your eFax Developer outbound password (required) req.setPassword("dog"); // Set the transmission identifier req.setTransmissionID("1234567890"); try { // Retrieve the transmission status from eFax Developer StatusResponse resp = req.getStatus(); Process the StatusResponse... } catch (Exception e) { e.printStackTrace(); } catch (Error err) { err.printStackTrace(); }
StatusResponse| Constructor Summary | |
|---|---|
StatusRequest()
Constructor method for the StatusRequest |
|
| Method Summary | |
|---|---|
int |
getConnectionTimeout()
Method used to retrieve the current connection timeout for the request. |
int |
getReadTimeout()
Method used to retrieve the current read timeout for the response. |
StatusResponse |
getStatus()
Method used to request a transmission status from eFax Developer™. |
boolean |
isHTMLResponse()
Method to determine if an HTML response was requested. |
void |
setAccountID(java.lang.String accountID)
Method used to set the client's account identifier. |
void |
setConnectionTimeout(int mills)
Method used to control the connection timeout for the request. |
void |
setDOCID(java.lang.String docID)
Method used to set eFax Developer's transmission identifier. |
void |
setHTMLResponse(boolean useHTML)
Method used to request an HTML-formatted response. |
void |
setPassword(java.lang.String password)
Method used to set the client's password. |
void |
setReadTimeout(int mills)
Method used to control the read timeout for the response. |
void |
setTransmissionID(java.lang.String transmissionID)
Method used to set the client generated transmission identifier. |
void |
setUserName(java.lang.String userName)
Method used to set the client's user name. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StatusRequest()
| Method Detail |
|---|
public StatusResponse getStatus()
throws java.lang.Exception
StatusResponse instance containing the response returned from eFax Developer™
java.lang.ExceptionStatusResponse,
setReadTimeout(int),
setConnectionTimeout(int)public boolean isHTMLResponse()
Selecting an HTML response limits the client-side application to formatted HTML returned
via the getRawResponse() method.
setHTMLResponse(boolean),
StatusResponse.getRawResponse()public void setDOCID(java.lang.String docID)
docID - the eFax Developer™ transmission identifierpublic void setHTMLResponse(boolean useHTML)
useHTML - a boolean value indicating that a standard HTML response is desiredStatusResponse.isHTMLResponse(),
isHTMLResponse()public void setTransmissionID(java.lang.String transmissionID)
transmissionID - the client generated transmission identifierpublic int getConnectionTimeout()
setConnectionTimeout(int)public int getReadTimeout()
setReadTimeout(int)public void setAccountID(java.lang.String accountID)
accountID - the client's account identifier used for authenticationpublic void setConnectionTimeout(int mills)
mills - an int value that specifies the connect timeout in millisecondsgetConnectionTimeout(),
sendFax(),
getStatus()public void setPassword(java.lang.String password)
The password value passed here must match the password specified in the Outbound Settings tab of the online user interface.
password - the client's outbound password used for authenticationpublic void setReadTimeout(int mills)
mills - an int value that specifies the read timeout in millisecondsgetReadTimeout(),
sendFax(),
getStatus()public void setUserName(java.lang.String userName)
The user name value passed here must match the user name specified in the Outbound Settings tab of the online user interface.
userName - the client's outbound user name used for authentication
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||