com.hellosign.sdk.resource

Class TemplateDraft

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractRequest

com.hellosign.sdk.resource.TemplateDraft

public class TemplateDraft
extends AbstractRequest

Represents a HelloSign template draft.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATE_DRAFT_ID
static String	TEMPLATE_DRAFT_KEY
static String	TEMPLATE_EDIT_URL
static String	TEMPLATE_EXPIRES_AT

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
TemplateDraft()
TemplateDraft(org.json.JSONObject json)

Method Summary

Modifier and Type	Method and Description
void	addCCRole(String ccRole) Adds a named role for a CC recipient that must be specified when the template is used.
void	addMergeField(String name, FieldType type) Add merge fields to the template draft.
void	addSignerRole(String signerRole) Adds the signer role to the template draft.
void	addSignerRole(String role, int order) Adds the signer role with the given order to the list of signers for this request.
void	clearMergeFields() Clears the current merge field map.
List<String>	getCCRoles() Returns the CC roles for this request.
String	getEditUrl() Returns the edit URL for creating an embedded template draft.
String	getExpiresAt() Returns the expiration time for the edit URL of this template.
String	getId() Returns the ID for this request.
Map<String,FieldType>	getMergeFields() Returns the current map of merge field names to types.
Map<String,Serializable>	getPostFields() Internal method used to retrieve the necessary POST fields.
List<String>	getSignerRoles() Returns the signer roles specified for this template draft.
boolean	hasEditUrl() Utility method to detect whether the "edit_url" parameter is set on this template object.
boolean	hasExpiresAt() Utility method to detect whether the "expires_at" parameter is set on this template object.
boolean	hasId() Returns true if this request has an ID.
boolean	removeSignerRole(String signerRole) Removes the signer role.
static String	serializeMergeFields(Map<String,FieldType> mergeFields) Helper method to convert a Java Map into the JSON string required by the HelloSign API.
void	setSignerRoles(List<String> signerRoles) Overwrites the current list of signer roles.

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

TEMPLATE_DRAFT_KEY

public static final String TEMPLATE_DRAFT_KEY

See Also:

Constant Field Values

TEMPLATE_DRAFT_ID

public static final String TEMPLATE_DRAFT_ID

See Also:

Constant Field Values

TEMPLATE_EDIT_URL

public static final String TEMPLATE_EDIT_URL

See Also:

Constant Field Values

TEMPLATE_EXPIRES_AT

public static final String TEMPLATE_EXPIRES_AT

See Also:

Constant Field Values

Constructor Detail

TemplateDraft

public TemplateDraft()

TemplateDraft

public TemplateDraft(org.json.JSONObject json)
              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

getCCRoles

public List<String> getCCRoles()

Returns the CC roles for this request.

Returns:

List

addCCRole

public void addCCRole(String ccRole)

Adds a named role for a CC recipient that must be specified when the template is used.

Parameters:

ccRole - String

addSignerRole

public void addSignerRole(String signerRole)

Adds the signer role to the template draft.

Parameters:

signerRole - String

getSignerRoles

public List<String> getSignerRoles()

Returns the signer roles specified for this template draft.

Returns:

List

addSignerRole

public void addSignerRole(String role,
                          int order)
                   throws HelloSignException

Adds the signer role 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:

role - String

order - int

Throws:

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

setSignerRoles

public void setSignerRoles(List<String> signerRoles)

Overwrites the current list of signer roles.

Parameters:

signerRoles - List

removeSignerRole

public boolean removeSignerRole(String signerRole)
                         throws HelloSignException

Removes the signer role.

Parameters:

signerRole - String

Returns:

boolean

Throws:

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

addMergeField

public void addMergeField(String name,
                          FieldType type)
                   throws HelloSignException

Add merge fields to the template draft. These are fields that your app can pre-populate whenever the *finished* template is used to send a signature request.

Parameters:

name - String name of the merge field that will be displayed to the user and used to key off the custom field when populating the value.

type - FieldType (currently only "text" and "checkbox" are allowed)

Throws:

HelloSignException - thrown if there is a problem adding the merge field.

getMergeFields

public Map<String,FieldType> getMergeFields()

Returns the current map of merge field names to types.

Returns:

Map

clearMergeFields

public void clearMergeFields()

Clears the current merge field map.

hasEditUrl

public boolean hasEditUrl()

Utility method to detect whether the "edit_url" parameter is set on this template object.

Returns:

boolean

getEditUrl

public String getEditUrl()

Returns the edit URL for creating an embedded template draft.

Returns:

String edit URL

hasExpiresAt

public boolean hasExpiresAt()

Utility method to detect whether the "expires_at" parameter is set on this template object.

Returns:

boolean

getExpiresAt

public String getExpiresAt()

Returns the expiration time for the edit URL of this template.

Returns:

String expiration timestamp

serializeMergeFields

public static String serializeMergeFields(Map<String,FieldType> mergeFields)
                                   throws HelloSignException

Helper method to convert a Java Map into the JSON string required by the HelloSign API.

Parameters:

mergeFields - Map

Returns:

String

Throws:

HelloSignException - Thrown if there's a problem parsing JSONObjects

getPostFields

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

Internal method used to retrieve the necessary POST fields.

Overrides:

getPostFields in class AbstractRequest

Returns:

Map

Throws:

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