com.box.sdkgen.schemas.signrequestbase

Class SignRequestBase

Object

NullableFieldTracker

SerializableObject

SignRequestBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SignRequest, SignRequestCreateRequest

public class SignRequestBase
extends SerializableObject

A standard representation of a signature request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignRequestBase.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	areRemindersEnabled Reminds signers to sign a document on day 3, 8, 13 and 18.
protected Boolean	areTextSignaturesEnabled Disables the usage of signatures generated by typing (text).
protected Long	daysValid Set the number of days after which the created signature request will automatically expire if not completed.
protected String	declinedRedirectUrl The uri that a signer will be redirected to after declining to sign a document.
protected String	emailMessage Message to include in sign request email.
protected String	emailSubject Subject of sign request email.
protected String	externalId This can be used to reference an ID in an external system that the sign request is related to.
protected String	externalSystemName Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`.
protected Boolean	isDocumentPreparationNeeded Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI.
protected String	name Name of the signature request.
protected List<SignRequestPrefillTag>	prefillTags When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
protected String	redirectUrl When specified, the signature request will be redirected to this url when a document is signed.
protected String	templateId When a signature request is created from a template this field will indicate the id of that template.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	SignRequestBase()
protected	SignRequestBase(SignRequestBase.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getAreRemindersEnabled()
Boolean	getAreTextSignaturesEnabled()
Long	getDaysValid()
String	getDeclinedRedirectUrl()
String	getEmailMessage()
String	getEmailSubject()
String	getExternalId()
String	getExternalSystemName()
Boolean	getIsDocumentPreparationNeeded()
String	getName()
List<SignRequestPrefillTag>	getPrefillTags()
String	getRedirectUrl()
String	getTemplateId()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

isDocumentPreparationNeeded

protected Boolean isDocumentPreparationNeeded

Indicates if the sender should receive a `prepare_url` in the response to complete document preparation using the UI.

redirectUrl

protected String redirectUrl

When specified, the signature request will be redirected to this url when a document is signed.

declinedRedirectUrl

protected String declinedRedirectUrl

The uri that a signer will be redirected to after declining to sign a document.

areTextSignaturesEnabled

protected Boolean areTextSignaturesEnabled

Disables the usage of signatures generated by typing (text).

emailSubject

protected String emailSubject

Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.

emailMessage

protected String emailMessage

Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.

areRemindersEnabled

protected Boolean areRemindersEnabled

Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.

name

protected String name

Name of the signature request.

prefillTags

protected List<SignRequestPrefillTag> prefillTags

When a document contains sign-related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.

daysValid

protected Long daysValid

Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.

externalId

protected String externalId

This can be used to reference an ID in an external system that the sign request is related to.

templateId

protected String templateId

When a signature request is created from a template this field will indicate the id of that template.

externalSystemName

protected String externalSystemName

Used as an optional system name to appear in the signature log next to the signers who have been assigned the `embed_url_external_id`.

Constructor Detail

SignRequestBase

public SignRequestBase()

SignRequestBase

protected SignRequestBase(SignRequestBase.Builder builder)

Method Detail

getIsDocumentPreparationNeeded

public Boolean getIsDocumentPreparationNeeded()

getRedirectUrl

public String getRedirectUrl()

getDeclinedRedirectUrl

public String getDeclinedRedirectUrl()

getAreTextSignaturesEnabled

public Boolean getAreTextSignaturesEnabled()

getEmailSubject

public String getEmailSubject()

getEmailMessage

public String getEmailMessage()

getAreRemindersEnabled

public Boolean getAreRemindersEnabled()

getName

public String getName()

getPrefillTags

public List<SignRequestPrefillTag> getPrefillTags()

getDaysValid

public Long getDaysValid()

getExternalId

public String getExternalId()

getTemplateId

public String getTemplateId()

getExternalSystemName

public String getExternalSystemName()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object