com.clicksend.controllers

Class FaxController

java.lang.Object

com.clicksend.controllers.BaseController

com.clicksend.controllers.FaxController

public class FaxController
extends BaseController

Field Summary

Fields inherited from class com.clicksend.controllers.BaseController

httpCallBack

Constructor Summary

Constructors

Constructor and Description
FaxController()

Method Summary

Modifier and Type	Method and Description
String	calculatePrice(FaxMessageCollection faxMessage) Calculate Total Price for Fax Messages sent
void	calculatePriceAsync(FaxMessageCollection faxMessage, APICallBack<String> callBack) Calculate Total Price for Fax Messages sent
String	faxReceiptList() Get List of Fax Receipts
void	faxReceiptListAsync(APICallBack<String> callBack) Get List of Fax Receipts
String	getFaxHistory(int dateFrom, int dateTo, String q, String order) Get a list of Fax History.
void	getFaxHistoryAsync(int dateFrom, int dateTo, String q, String order, APICallBack<String> callBack) Get a list of Fax History.
String	getFaxReceipt(int messageId) Get a single fax receipt based on message id.
void	getFaxReceiptAsync(int messageId, APICallBack<String> callBack) Get a single fax receipt based on message id.
static FaxController	getInstance() Singleton pattern implementation
String	sendFax(FaxMessageCollection faxMessage) Send a fax using supplied supported file-types.
void	sendFaxAsync(FaxMessageCollection faxMessage, APICallBack<String> callBack) Send a fax using supplied supported file-types.

Methods inherited from class com.clicksend.controllers.BaseController

getClientInstance, getHttpCallBack, setClientInstance, setHttpCallBack, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaxController

public FaxController()

Method Detail

getInstance

public static FaxController getInstance()

Singleton pattern implementation

Returns:

The singleton instance of the FaxController class

getFaxReceipt

public String getFaxReceipt(int messageId)
                     throws Throwable

Get a single fax receipt based on message id.

Parameters:

messageId - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

getFaxReceiptAsync

public void getFaxReceiptAsync(int messageId,
                               APICallBack<String> callBack)

Get a single fax receipt based on message id.

Parameters:

messageId - Required parameter: Example:

getFaxHistory

public String getFaxHistory(int dateFrom,
                            int dateTo,
                            String q,
                            String order)
                     throws Throwable

Get a list of Fax History.

Parameters:

dateFrom - Required parameter: Customize result by setting from date (timestsamp) Example: 1457572619.

dateTo - Required parameter: Customize result by setting to date (timestamp) Example: 1457573000.

q - Required parameter: Custom query Example: status:Sent,status_code:201.

order - Required parameter: Order result by Example: date_added:desc,list_id:desc.

Returns:

Returns the String response from the API call

Throws:

Throwable

getFaxHistoryAsync

public void getFaxHistoryAsync(int dateFrom,
                               int dateTo,
                               String q,
                               String order,
                               APICallBack<String> callBack)

Get a list of Fax History.

Parameters:

dateFrom - Required parameter: Customize result by setting from date (timestsamp) Example: 1457572619.

dateTo - Required parameter: Customize result by setting to date (timestamp) Example: 1457573000.

q - Required parameter: Custom query Example: status:Sent,status_code:201.

order - Required parameter: Order result by Example: date_added:desc,list_id:desc.

faxReceiptList

public String faxReceiptList()
                      throws Throwable

Get List of Fax Receipts

Returns:

Returns the String response from the API call

Throws:

Throwable

faxReceiptListAsync

public void faxReceiptListAsync(APICallBack<String> callBack)

Get List of Fax Receipts

calculatePrice

public String calculatePrice(FaxMessageCollection faxMessage)
                      throws Throwable

Calculate Total Price for Fax Messages sent

Parameters:

faxMessage - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

calculatePriceAsync

public void calculatePriceAsync(FaxMessageCollection faxMessage,
                                APICallBack<String> callBack)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Calculate Total Price for Fax Messages sent

Parameters:

faxMessage - Required parameter: Example:

Throws:

com.fasterxml.jackson.core.JsonProcessingException

sendFax

public String sendFax(FaxMessageCollection faxMessage)
               throws Throwable

Send a fax using supplied supported file-types.

Parameters:

faxMessage - Required parameter: Example:

Returns:

Returns the String response from the API call

Throws:

Throwable

sendFaxAsync

public void sendFaxAsync(FaxMessageCollection faxMessage,
                         APICallBack<String> callBack)
                  throws com.fasterxml.jackson.core.JsonProcessingException

Send a fax using supplied supported file-types.

Parameters:

faxMessage - Required parameter: Example:

Throws:

com.fasterxml.jackson.core.JsonProcessingException