com.hoiio.sdk.objects.fax
Class Fax

java.lang.Object
  extended by com.hoiio.sdk.objects.HoiioResponse
      extended by com.hoiio.sdk.objects.fax.Fax

public class Fax
extends HoiioResponse


Constructor Summary
Fax(net.sf.json.JSONObject output)
          Constructs a new Fax object by decoding the JSONObject as a response from the HTTP Request
 
Method Summary
 Currency getCurrency()
          Gets the currency used for this transaction
 Date getDate()
          Gets the date of this transaction
 double getDebit()
          Gets the total amount billed for this transaction
 String getDest()
          Gets the destination that the fax is sent to
 int getFaxPages()
          Gets the number of fax pages sent
 FaxStatus getFaxStatus()
          Gets the dial status of the fax
 String getFaxUrl()
          Gets the link to download the PDF file
 double getRate()
          Gets the per-minute charges for this fax transaction
 String getSrc()
          Gets the source number of the fax transaction
 String getTag()
          Gets the reference ID submmited in the initial fax request
 String getTxnRef()
          Gets the unique reference iD for this transaction
 
Methods inherited from class com.hoiio.sdk.objects.HoiioResponse
getContent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Fax

public Fax(net.sf.json.JSONObject output)
    throws HoiioException
Constructs a new Fax object by decoding the JSONObject as a response from the HTTP Request

Parameters:
output - The response of the HTTP Request
Throws:
HoiioException
Method Detail

getCurrency

public Currency getCurrency()
Gets the currency used for this transaction

Returns:
Currency used for this transaction.

getDate

public Date getDate()
Gets the date of this transaction

Returns:
Date/time (GMT+8) of the fax in "YYYY-MM-DD HH:MM:SS" format.

getDebit

public double getDebit()
Gets the total amount billed for this transaction

Returns:
Total amount billed for this transaction.

getDest

public String getDest()
Gets the destination that the fax is sent to

Returns:
The destination of the fax transaction. Phone numbers start with a "+" and country code (E.164 format), e.g. +6511111111.

getFaxPages

public int getFaxPages()
Gets the number of fax pages sent

Returns:
The number of fax pages sent.

getFaxStatus

public FaxStatus getFaxStatus()
Gets the dial status of the fax

Returns:
Dial status of the fax.

getFaxUrl

public String getFaxUrl()
Gets the link to download the PDF file

Returns:
Link to download the PDF file of the fax.

getRate

public double getRate()
Gets the per-minute charges for this fax transaction

Returns:
Per-minute charges for this fax transaction.

getSrc

public String getSrc()
Gets the source number of the fax transaction

Returns:
The source of the fax transaction. For outgoing fax this value is empty. Phone numbers start with a "+" and country code (E.164 format), e.g. +6511111111.

getTag

public String getTag()
Gets the reference ID submmited in the initial fax request

Returns:
Your own reference ID submitted in the initial fax Send request. This parameter will not be present if it wasn't included in the initial request.

getTxnRef

public String getTxnRef()
Gets the unique reference iD for this transaction

Returns:
The unique reference ID for this transaction.