Package com.hellosign.sdk.resource.support

Class Signature

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.support.Signature

public class Signature
extends AbstractResource

Contains information related to a signature / signer.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SIGNATURE_ID
static java.lang.String	SIGNATURE_KEY
static java.lang.String	SIGNER_DECLINE_REASON
static java.lang.String	SIGNER_EMAIL_ADDRESS
static java.lang.String	SIGNER_LAST_REMINDED_AT
static java.lang.String	SIGNER_LAST_VIEWED_AT
static java.lang.String	SIGNER_NAME
static java.lang.String	SIGNER_ORDER
static java.lang.String	SIGNER_SIGNED_AT
static java.lang.String	SIGNER_STATUS_CODE

Fields inherited from class com.hellosign.sdk.resource.AbstractResource

dataObj, warnings

Constructor Summary

Constructors

Constructor	Description
Signature()
Signature(org.json.JSONObject json)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getDateSigned()	Returns the date the signer signed the request.
java.lang.String	getDeclineReason()	Returns the reason the signer declined this request.
java.lang.String	getEmail()	Returns the email address of the signer.
java.lang.String	getId()	Returns the ID of the signer.
java.util.Date	getLastReminded()	Returns the date at which the last reminder was sent to this signer.
java.util.Date	getLastViewed()	Returns the date the signer last viewed the request.
java.lang.String	getName()	Returns the name of the signer.
java.lang.Integer	getOrder()	Returns the order of this signer.
SignatureStatus	getStatus()	Returns the status of this signature/signer.
java.lang.String	getStatusString()	Returns the status in string format.
boolean	hasEmail()	Returns true if this signature object has an email address.
boolean	hasId()	Returns true if this signature object has a signature ID.
boolean	hasName()	Returns true if this signature object has a name

Methods inherited from class com.hellosign.sdk.resource.AbstractResource

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getObject, getString, getWarnings, has, hasString, set, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

SIGNATURE_KEY

public static final java.lang.String SIGNATURE_KEY

See Also:

Constant Field Values

SIGNATURE_ID

public static final java.lang.String SIGNATURE_ID

See Also:

Constant Field Values

SIGNER_EMAIL_ADDRESS

public static final java.lang.String SIGNER_EMAIL_ADDRESS

See Also:

Constant Field Values

SIGNER_NAME

public static final java.lang.String SIGNER_NAME

See Also:

Constant Field Values

SIGNER_ORDER

public static final java.lang.String SIGNER_ORDER

See Also:

Constant Field Values

SIGNER_STATUS_CODE

public static final java.lang.String SIGNER_STATUS_CODE

See Also:

Constant Field Values

SIGNER_SIGNED_AT

public static final java.lang.String SIGNER_SIGNED_AT

See Also:

Constant Field Values

SIGNER_LAST_VIEWED_AT

public static final java.lang.String SIGNER_LAST_VIEWED_AT

See Also:

Constant Field Values

SIGNER_LAST_REMINDED_AT

public static final java.lang.String SIGNER_LAST_REMINDED_AT

See Also:

Constant Field Values

SIGNER_DECLINE_REASON

public static final java.lang.String SIGNER_DECLINE_REASON

See Also:

Constant Field Values

Constructor Detail

Signature

public Signature()

Signature

public Signature(org.json.JSONObject json)
          throws HelloSignException

Throws:

HelloSignException

Method Detail

getId

public java.lang.String getId()

Returns the ID of the signer.

Returns:

String ID

hasId

public boolean hasId()

Returns true if this signature object has a signature ID.

Returns:

boolean

getEmail

public java.lang.String getEmail()

Returns the email address of the signer.

Returns:

String email address

hasEmail

public boolean hasEmail()

Returns true if this signature object has an email address.

Returns:

boolean

getName

public java.lang.String getName()

Returns the name of the signer.

Returns:

String signer name

hasName

public boolean hasName()

Returns true if this signature object has a name

Returns:

boolean

getOrder

public java.lang.Integer getOrder()

Returns the order of this signer.

Returns:

Integer signer order

getStatus

public SignatureStatus getStatus()

Returns the status of this signature/signer.

Returns:

SignatureStatus status

getStatusString

public java.lang.String getStatusString()

Returns the status in string format.

Returns:

String status

getDateSigned

public java.util.Date getDateSigned()

Returns the date the signer signed the request.

Returns:

Date date the signer signed

getLastViewed

public java.util.Date getLastViewed()

Returns the date the signer last viewed the request.

Returns:

Date date the signer last viewed

getLastReminded

public java.util.Date getLastReminded()

Returns the date at which the last reminder was sent to this signer.

Returns:

Date date the last reminder was sent

getDeclineReason

public java.lang.String getDeclineReason()

Returns the reason the signer declined this request.

Returns:

string or null if the request does not have a decline_reason