public class TemplateSignatureRequest extends AbstractRequest
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_TAGSdataObj, warnings| Constructor and Description |
|---|
TemplateSignatureRequest() |
TemplateSignatureRequest(List<Template> templates)
Convenience constructor that accepts a list of Templates.
|
TemplateSignatureRequest(Template template)
Convenience constructor that accepts a single Template.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addTemplateId(String id)
Adds the template ID to be used in this request.
|
void |
addTemplateId(String id,
Integer index)
Add the template ID to be used at the specified index.
|
void |
clearCCs()
Clears the list of current CC email addresses.
|
void |
clearCustomFields()
Clears the current custom fields for this request.
|
Map<String,String> |
getCCs()
Returns a reference to the map of current roles
to CC email addresses.
|
Map<String,String> |
getCustomFields()
Returns the map of custom fields for the template.
|
String |
getId() |
Map<String,Serializable> |
getPostFields()
Internal method used to retrieve the necessary POST fields to submit the
signature request.
|
Map<String,Signer> |
getSigners()
Returns a reference to the signers list.
|
String |
getTemplateId()
Get the template ID that will be used with this request.
|
List<String> |
getTemplateIds()
Get the list of template IDs that are used for this request.
|
boolean |
hasHideTextTags()
Not implemented for templates.
|
boolean |
hasUseTextTags()
Not implemented for templates.
|
Boolean |
isHidingTextTags()
Not implemented for templates.
|
Boolean |
isUsingTextTags()
Not implemented for templates.
|
void |
removeSignerByEmail(String email)
Removes signer(s) from this request by email address.
|
void |
setCC(String role,
String email)
Sets the CC email address for the provided role.
|
void |
setCCs(Map<String,String> newCCs)
Overwrites the map of roles to CC email addresses.
|
void |
setCustomFields(Map<String,String> fields)
Overwrites the current map of custom fields to the provided map.
|
void |
setCustomFieldValue(String fieldName,
String value)
Adds the value to fill in for a custom field with the given field name.
|
void |
setHideTextTags(boolean hideTextTags)
Not implemented for templates.
|
void |
setSigner(String role,
String email,
String name)
Adds the signer to the list of signers for this request.
|
void |
setSigners(Map<String,Signer> signers)
Overwrites the current list of signers for this request with the
given list.
|
void |
setTemplateId(String id)
Set the template ID of the template that should be used with this request.
|
void |
setUseTextTags(boolean useTextTags)
Not implemented for templates.
|
addDocument, addDocument, addFile, addFile, addFileUrl, addMetadata, clearDocuments, getDocuments, getFileUrls, getMessage, getMetadata, getMetadata, getOrderMatters, getRedirectUrl, getSubject, getTitle, hasMessage, hasRedirectUrl, hasSubject, hasTitle, hasUsePreexistingFields, isTestMode, isUsingPreexistingFields, setDocuments, setFileUrls, setMessage, setOrderMatters, setRedirectUrl, setSubject, setTestMode, setTitle, setUsePreexistingFieldsadd, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getString, getWarnings, has, hasString, set, toStringpublic TemplateSignatureRequest()
public TemplateSignatureRequest(Template template) throws HelloSignException
template - TemplateHelloSignExceptionpublic TemplateSignatureRequest(List<Template> templates) throws HelloSignException
templates - ListHelloSignExceptionpublic Map<String,String> getCCs()
public void setCCs(Map<String,String> newCCs)
newCCs - public void setCC(String role, String email)
role - Stringemail - Stringpublic void clearCCs()
public void setSigner(String role, String email, String name) throws HelloSignException
email - Stringname - StringHelloSignExceptionpublic Map<String,Signer> getSigners()
public void setSigners(Map<String,Signer> signers)
signers - Listpublic void removeSignerByEmail(String email) throws HelloSignException
email - StringHelloSignExceptionpublic void setCustomFieldValue(String fieldName, String value)
fieldName - String field name to be filled invalue - String valuepublic Map<String,String> getCustomFields()
public void setCustomFields(Map<String,String> fields)
fields - Mappublic void clearCustomFields()
public void setTemplateId(String id) throws HelloSignException
id - StringHelloSignExceptionpublic String getTemplateId() throws HelloSignException
HelloSignExceptionpublic void addTemplateId(String id) throws HelloSignException
id - HelloSignExceptionpublic void addTemplateId(String id, Integer index) throws HelloSignException
id - index - HelloSignExceptionpublic List<String> getTemplateIds()
public Map<String,Serializable> getPostFields() throws HelloSignException
getPostFields in class AbstractRequestHelloSignExceptionpublic String getId()
getId in class AbstractRequestpublic boolean hasUseTextTags()
hasUseTextTags in class AbstractRequestpublic Boolean isUsingTextTags()
isUsingTextTags in class AbstractRequestpublic void setUseTextTags(boolean useTextTags)
setUseTextTags in class AbstractRequestpublic boolean hasHideTextTags()
hasHideTextTags in class AbstractRequestpublic Boolean isHidingTextTags()
isHidingTextTags in class AbstractRequestpublic void setHideTextTags(boolean hideTextTags)
setHideTextTags in class AbstractRequestCopyright © 2015 HelloSign. All rights reserved.