com.hellosign.sdk.resource

Class EmbeddedRequest

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractRequest

com.hellosign.sdk.resource.EmbeddedRequest

public class EmbeddedRequest
extends AbstractRequest

Represents an Embedded signature request (either standard or templated). An embedded request is one that can be signed from either within HelloSign or from within an iFrame on your website.

Author:

"Chris Paul (chris@hellosign.com)"

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMBEDDED_CLIENT_ID

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

REQUEST_ALLOW_DECLINE, REQUEST_ALLOW_REASSIGN, REQUEST_CLIENT_ID, REQUEST_CUSTOM_FIELDS, 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
EmbeddedRequest(String clientId, AbstractRequest request) Creates an Embedded signature request using the client ID and the AbstractRequest object provided.

Method Summary

Modifier and Type	Method and Description
void	addCustomField(CustomField field) Add the custom field to this request.
void	clearCustomFields() Clears the current custom fields for this request.
String	getClientId() Set the client ID of the web app you're using to create this embedded signature request.
List<CustomField>	getCustomFields() Gets the custom fields associated with this request, set when sending the request.
Map<String,String>	getCustomFieldsMap() Returns the map of custom fields for the request.
String	getId()
String	getMessage()
Map<String,Serializable>	getPostFields()
String	getRedirectUrl()
AbstractRequest	getRequest() Get the AbstractRequest associated with this Embedded signature request.
String	getSubject()
String	getTitle()
boolean	hasMessage()
boolean	hasRedirectUrl()
boolean	hasSubject()
boolean	hasTitle()
boolean	isTestMode()
void	setClientId(String clientId) Set the client ID of the web app you're using to create this embedded signature request.
void	setCustomFields(Map<String,String> fields) Overwrites the current map of custom fields to the provided map.
void	setCustomFieldValue(String fieldNameOrApiId, String value) Adds the value to fill in for a custom field with the given field name.
void	setMessage(String message)
void	setRedirectUrl(String url)
void	setRequest(AbstractRequest request) Set the AbstractRequest associated with this Embedded signature request.
void	setSubject(String subject)
void	setTestMode(boolean testMode)
void	setTitle(String title)

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

addDocument, addDocument, addFile, addFile, addFileUrl, addMetadata, clearDocuments, getCustomFieldsList, getDocuments, getFileUrls, getIsDeclinable, getMetadata, getMetadata, getOrderMatters, getUxVersion, hasAllowReassign, hasHideTextTags, hasUsePreexistingFields, hasUseTextTags, isAllowReassign, isHidingTextTags, isUsingPreexistingFields, isUsingTextTags, setAllowReassign, setDocuments, setFileUrls, setHideTextTags, setIsDeclinable, setOrderMatters, 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

EMBEDDED_CLIENT_ID

public static final String EMBEDDED_CLIENT_ID

See Also:

Constant Field Values

Constructor Detail

EmbeddedRequest

public EmbeddedRequest(String clientId,
                       AbstractRequest request)

Creates an Embedded signature request using the client ID and the AbstractRequest object provided. First, instantiate the request object (either a SignatureRequest or TemplateSignatureRequest) and then create your EmbeddedRequest using that object.

Parameters:

clientId - String client ID

request - AbstractRequest

Method Detail

getClientId

public String getClientId()

Set the client ID of the web app you're using to create this embedded signature request. See: http://app.hellosign.com/api/embedded

Overrides:

getClientId in class AbstractRequest

Returns:

String client ID

setClientId

public void setClientId(String clientId)

Set the client ID of the web app you're using to create this embedded signature request. See: http://app.hellosign.com/api/embedded

Overrides:

setClientId in class AbstractRequest

Parameters:

clientId - String client ID

getRequest

public AbstractRequest getRequest()

Get the AbstractRequest associated with this Embedded signature request.

Returns:

AbstractRequest

setRequest

public void setRequest(AbstractRequest request)

Set the AbstractRequest associated with this Embedded signature request.

Parameters:

request - AbstractRequest

getPostFields

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

Overrides:

getPostFields in class AbstractRequest

Throws:

HelloSignException

getTitle

public String getTitle()

Overrides:

getTitle in class AbstractRequest

setTitle

public void setTitle(String title)

Overrides:

setTitle in class AbstractRequest

hasTitle

public boolean hasTitle()

Overrides:

hasTitle in class AbstractRequest

getSubject

public String getSubject()

Overrides:

getSubject in class AbstractRequest

setSubject

public void setSubject(String subject)

Overrides:

setSubject in class AbstractRequest

hasSubject

public boolean hasSubject()

Overrides:

hasSubject in class AbstractRequest

getMessage

public String getMessage()

Overrides:

getMessage in class AbstractRequest

setMessage

public void setMessage(String message)

Overrides:

setMessage in class AbstractRequest

hasMessage

public boolean hasMessage()

Overrides:

hasMessage in class AbstractRequest

setTestMode

public void setTestMode(boolean testMode)

Overrides:

setTestMode in class AbstractRequest

isTestMode

public boolean isTestMode()

Overrides:

isTestMode in class AbstractRequest

getRedirectUrl

public String getRedirectUrl()

Overrides:

getRedirectUrl in class AbstractRequest

setRedirectUrl

public void setRedirectUrl(String url)

Overrides:

setRedirectUrl in class AbstractRequest

hasRedirectUrl

public boolean hasRedirectUrl()

Overrides:

hasRedirectUrl in class AbstractRequest

getId

public String getId()

Specified by:

getId in class AbstractRequest

addCustomField

public void addCustomField(CustomField field)

Description copied from class: AbstractRequest

Add the custom field to this request. This is useful for specifying a pre-filled value and/or a field editor.

Overrides:

addCustomField in class AbstractRequest

Parameters:

field - CustomField

setCustomFieldValue

public void setCustomFieldValue(String fieldNameOrApiId,
                                String value)

Description copied from class: AbstractRequest

Adds the value to fill in for a custom field with the given field name.

Overrides:

setCustomFieldValue in class AbstractRequest

Parameters:

fieldNameOrApiId - String name (or "Field Label") of the custom field to be filled in. The "api_id" can also be used instead of the name.

value - String value

getCustomFields

public List<CustomField> getCustomFields()

Description copied from class: AbstractRequest

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

Overrides:

getCustomFields in class AbstractRequest

Returns:

List CustomFields

getCustomFieldsMap

public Map<String,String> getCustomFieldsMap()

Description copied from class: AbstractRequest

Returns the map of custom fields for the request. This is a map of String field names to String field values.

Overrides:

getCustomFieldsMap in class AbstractRequest

Returns:

Map

setCustomFields

public void setCustomFields(Map<String,String> fields)

Description copied from class: AbstractRequest

Overwrites the current map of custom fields to the provided map. This is a map of String field names to String field values.

Overrides:

setCustomFields in class AbstractRequest

Parameters:

fields - Map

clearCustomFields

public void clearCustomFields()

Description copied from class: AbstractRequest

Clears the current custom fields for this request.

Overrides:

clearCustomFields in class AbstractRequest