com.hellosign.sdk.resource

Class SignatureRequest

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractRequest

com.hellosign.sdk.resource.SignatureRequest

public class SignatureRequest
extends AbstractRequest

Represents a HelloSign signature request. This object is used to both submit a request and to represent the request object returned from the server.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIGREQ_CCS
static String	SIGREQ_CUSTOM_FIELDS
static String	SIGREQ_DETAILS_URL
static String	SIGREQ_FILES
static String	SIGREQ_FILES_URL
static String	SIGREQ_FINAL_COPY_URL
static String	SIGREQ_FORM_FIELDS
static String	SIGREQ_FORMAT_PDF
static String	SIGREQ_FORMAT_ZIP
static String	SIGREQ_HAS_ERROR
static String	SIGREQ_ID
static String	SIGREQ_IS_COMPLETE
static String	SIGREQ_IS_DECLINED
static String	SIGREQ_KEY
static String	SIGREQ_RESPONSE_DATA
static String	SIGREQ_SIGNER_EMAIL
static String	SIGREQ_SIGNER_NAME
static String	SIGREQ_SIGNER_ORDER
static String	SIGREQ_SIGNER_PIN
static String	SIGREQ_SIGNERS
static String	SIGREQ_SIGNING_URL

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

REQUEST_ALLOW_DECLINE, REQUEST_CLIENT_ID, REQUEST_HIDE_TEXT_TAGS, REQUEST_MESSAGE, REQUEST_METADATA, REQUEST_REDIRECT_URL, REQUEST_SUBJECT, REQUEST_TEST_MODE, REQUEST_TITLE, REQUEST_USE_PREEXISTING_FIELDS, REQUEST_USE_TEXT_TAGS, REQUEST_UX_VERSION, UX_VERSION_1, UX_VERSION_2

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

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
SignatureRequest()
SignatureRequest(org.json.JSONObject json)
SignatureRequest(org.json.JSONObject json, String key)

Method Summary

Modifier and Type	Method and Description
void	addCC(String email) Adds a CC'd email address to this request.
void	addSigner(Signer signer) Adds the signer to the list of signers for this request.
void	addSigner(String email, String name) Adds the signer to the list of signers for this request.
void	addSigner(String email, String name, int order) Adds the signer with the given order to the list of signers for this request.
List<String>	getCCs() Returns the CC email addresses for this request.
List<CustomField>	getCustomFields() Gets the custom fields associated with this request, set when sending the request from a template.
String	getDetailsUrl()
String	getFilesUrl() Returns the API URL to retrieve the PDF copy of this signature request.
String	getFinalCopyUrl() Deprecated. use getFilesUrl()
String	getId() Returns the ID for this request.
Map<String,Serializable>	getPostFields() Internal method used to retrieve the necessary POST fields to submit the signature request.
List<ResponseData>	getResponseData()
Signature	getSignature(String email, String name) Returns the signature for the given email/name combination, or null if not found on this request.
Signature	getSignatureBySigner(String email, String name) Deprecated. Use getSignature(email, name)
List<Signature>	getSignatures() Returns a list of signatures for this request.
List<Signer>	getSigners() Returns a reference to the signers list.
String	getSigningUrl()
boolean	hasError()
boolean	hasId() Returns true if this request has an ID.
boolean	isComplete() Returns the HelloSign-designated signature status, indicating whether all signers have signed the document.
boolean	isDeclined()
void	removeSigner(String email) Removes the signer from the list.
void	setSigners(List<Signer> signers) Overwrites the current list of signers for this request with the given list.

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

addDocument, addDocument, addFile, addFile, addFileUrl, addMetadata, clearDocuments, getClientId, getDocuments, getFileUrls, getIsDeclinable, getMessage, getMetadata, getMetadata, getOrderMatters, getRedirectUrl, getSubject, getTitle, getUxVersion, hasHideTextTags, hasMessage, hasRedirectUrl, hasSubject, hasTitle, hasUsePreexistingFields, hasUseTextTags, isHidingTextTags, isTestMode, isUsingPreexistingFields, isUsingTextTags, setClientId, setDocuments, setFileUrls, setHideTextTags, setIsDeclinable, setMessage, setOrderMatters, setRedirectUrl, setSubject, setTestMode, setTitle, setUsePreexistingFields, setUseTextTags, setUxVersion

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

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, 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

SIGREQ_KEY

public static final String SIGREQ_KEY

See Also:

Constant Field Values

SIGREQ_ID

public static final String SIGREQ_ID

See Also:

Constant Field Values

SIGREQ_SIGNERS

public static final String SIGREQ_SIGNERS

See Also:

Constant Field Values

SIGREQ_SIGNER_EMAIL

public static final String SIGREQ_SIGNER_EMAIL

See Also:

Constant Field Values

SIGREQ_SIGNER_NAME

public static final String SIGREQ_SIGNER_NAME

See Also:

Constant Field Values

SIGREQ_SIGNER_ORDER

public static final String SIGREQ_SIGNER_ORDER

See Also:

Constant Field Values

SIGREQ_SIGNER_PIN

public static final String SIGREQ_SIGNER_PIN

See Also:

Constant Field Values

SIGREQ_CCS

public static final String SIGREQ_CCS

See Also:

Constant Field Values

SIGREQ_FILES

public static final String SIGREQ_FILES

See Also:

Constant Field Values

SIGREQ_FORM_FIELDS

public static final String SIGREQ_FORM_FIELDS

See Also:

Constant Field Values

SIGREQ_IS_COMPLETE

public static final String SIGREQ_IS_COMPLETE

See Also:

Constant Field Values

SIGREQ_HAS_ERROR

public static final String SIGREQ_HAS_ERROR

See Also:

Constant Field Values

SIGREQ_RESPONSE_DATA

public static final String SIGREQ_RESPONSE_DATA

See Also:

Constant Field Values

SIGREQ_FINAL_COPY_URL

public static final String SIGREQ_FINAL_COPY_URL

See Also:

Constant Field Values

SIGREQ_FILES_URL

public static final String SIGREQ_FILES_URL

See Also:

Constant Field Values

SIGREQ_SIGNING_URL

public static final String SIGREQ_SIGNING_URL

See Also:

Constant Field Values

SIGREQ_DETAILS_URL

public static final String SIGREQ_DETAILS_URL

See Also:

Constant Field Values

SIGREQ_IS_DECLINED

public static final String SIGREQ_IS_DECLINED

See Also:

Constant Field Values

SIGREQ_CUSTOM_FIELDS

public static final String SIGREQ_CUSTOM_FIELDS

See Also:

Constant Field Values

SIGREQ_FORMAT_ZIP

public static final String SIGREQ_FORMAT_ZIP

See Also:

Constant Field Values

SIGREQ_FORMAT_PDF

public static final String SIGREQ_FORMAT_PDF

See Also:

Constant Field Values

Constructor Detail

SignatureRequest

public SignatureRequest()

SignatureRequest

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

Throws:

HelloSignException

SignatureRequest

public SignatureRequest(org.json.JSONObject json,
                        String key)
                 throws HelloSignException

Throws:

HelloSignException

Method Detail

getId

public String getId()

Returns the ID for this request.

Specified by:

getId in class AbstractRequest

hasId

public boolean hasId()

Returns true if this request has an ID. Useful if checking to see if this request is for submission or is the result of a call to HelloSign.

Returns:

true if the request has an ID, false otherwise

getCCs

public List<String> getCCs()

Returns the CC email addresses for this request.

Returns:

List

addCC

public void addCC(String email)

Adds a CC'd email address to this request.

Parameters:

email - String email address

getSignatures

public List<Signature> getSignatures()

Returns a list of signatures for this request.

Returns:

List

getSignature

public Signature getSignature(String email,
                              String name)
                       throws HelloSignException

Returns the signature for the given email/name combination, or null if not found on this request.

Parameters:

email - String email address

name - String name

Returns:

Signature or null if not found

Throws:

HelloSignException - if the email or name are empty

addSigner

public void addSigner(Signer signer)
               throws HelloSignException

Adds the signer to the list of signers for this request.

Parameters:

signer - Signer

Throws:

HelloSignException - thrown if there is a problem adding the signer.

addSigner

public void addSigner(String email,
                      String name)
               throws HelloSignException

Adds the signer to the list of signers for this request.

Parameters:

email - String

name - String

Throws:

HelloSignException - thrown if there is a problem adding the signer.

addSigner

public void addSigner(String email,
                      String name,
                      int order)
               throws HelloSignException

Adds the signer with the given order to the list of signers for this request. NOTE: The order refers to the 1-base index, not 0-base. This is to reflect the indexing used by the HelloSign API. This means that adding an item at order 1 will place it in the 0th index of the list (it will be the first item).

Parameters:

email - String

name - String

order - int

Throws:

HelloSignException - thrown if there is a problem adding the signer.

getSigners

public List<Signer> getSigners()

Returns a reference to the signers list. This can be modified and re-added to the request using setSigners(). Useful for more explicit modification.

Returns:

List

setSigners

public void setSigners(List<Signer> signers)

Overwrites the current list of signers for this request with the given list.

Parameters:

signers - List

removeSigner

public void removeSigner(String email)
                  throws HelloSignException

Removes the signer from the list. If that user does not exist, this will throw a HelloSignException.

Parameters:

email - String

Throws:

HelloSignException - thrown if there is a problem removing the signer.

getSignatureBySigner

public Signature getSignatureBySigner(String email,
                                      String name)

Deprecated. Use getSignature(email, name)

Utility method that allows you to search for a Signature object on this request by email and name. It requires both because neither alone is enough to guarantee uniqueness (some requests can have multiple signers using the same email address or name).

Parameters:

email - String

name - String

Returns:

Signature, if found on this request, or null

getPostFields

public Map<String,Serializable> getPostFields()
                                       throws HelloSignException

Internal method used to retrieve the necessary POST fields to submit the signature request.

Overrides:

getPostFields in class AbstractRequest

Returns:

Map

Throws:

HelloSignException - thrown if there is a problem serializing the POST fields.

isComplete

public boolean isComplete()

Returns the HelloSign-designated signature status, indicating whether all signers have signed the document.

Returns:

true, if all signers have signed the document, false otherwise.

hasError

public boolean hasError()

getResponseData

public List<ResponseData> getResponseData()

getFinalCopyUrl

public String getFinalCopyUrl()

Deprecated. use getFilesUrl()

Returns:

String URL

getFilesUrl

public String getFilesUrl()

Returns the API URL to retrieve the PDF copy of this signature request.

Returns:

String URL

getSigningUrl

public String getSigningUrl()

getDetailsUrl

public String getDetailsUrl()

isDeclined

public boolean isDeclined()

getCustomFields

public List<CustomField> getCustomFields()

Gets the custom fields associated with this request, set when sending the request from a template.

Returns:

List CustomFields