com.box.sdk

Class BoxSignRequestCreateParams

Object

BoxSignRequestCreateParams

public class BoxSignRequestCreateParams
extends Object

Optional parameters for creating a Sign Request.

See Also:

BoxSignRequest

Constructor Summary

Constructors

Constructor and Description
BoxSignRequestCreateParams()

Method Summary

Modifier and Type	Method and Description
void	appendParamsAsJson(JsonObject requestJSON) Used to append BoxSignRequestCreateParams to request.
boolean	getAreDatesEnabled() Gets the flag indicating if ability for signer to add dates is enabled.
boolean	getAreRemindersEnabled() Gets the flag indicating if remind for signers to sign a document on day 3, 8, 13 and 18 (or less if the document has been digitally signed already) is enabled.
boolean	getAreTextSignaturesEnabled() Gets the flag indicating if usage of signatures generated by typing (text) is enabled.
int	getDaysValid() Gets the number of days after which this request will automatically expire if not completed.
String	getDeclinedRedirectUrl() Gets the URL that a signer will be redirected to after declining to sign a document.
String	getEmailMessage() Gets the message to include in sign request email.
String	getEmailSubject() Gets the subject of sign request email.
String	getExternalId() Gets an ID that serve as reference in an external system that the sign request is related to.
boolean	getIsDocumentPreparationNeeded() Gets the flag indicating if the sender should be taken into the builder flow to prepare the document.
String	getName() Gets the name of this sign request.
List<BoxSignRequestPrefillTag>	getPrefillTags() Gets the list of prefill tags.
String	getRedirectUrl() Gets the redirect URL that a signer will be redirected to after signing a document.
BoxSignRequestSignatureColor	getSignatureColor() Gets the forced, specific color for the signature.
String	getTemplateId() Gets the Sign Template ID of the Sign Request.
BoxSignRequestCreateParams	setAreDatesEnabled(boolean areDatesEnabled) Sets the flag indicating if ability for signer to add dates is enabled.
BoxSignRequestCreateParams	setAreRemindersEnabled(boolean areRemindersEnabled) Sets the flag indicating if remind for signers to sign a document on day 3, 8, 13 and 18 (or less if the document has been digitally signed already) is enabled.
BoxSignRequestCreateParams	setAreTextSignaturesEnabled(boolean areTextSignaturesEnabled) Sets the flag indicating if usage of signatures generated by typing (text) is enabled.
BoxSignRequestCreateParams	setDaysValid(int daysValid) Sets the number of days after which this request will automatically expire if not completed.
BoxSignRequestCreateParams	setDeclinedRedirectUrl(String declinedRedirectUrl) Sets the URL that a signer will be redirected to after declining to sign a document.
BoxSignRequestCreateParams	setEmailMessage(String emailMessage) Sets the message to include in sign request email.
BoxSignRequestCreateParams	setEmailSubject(String emailSubject) Sets the subject of sign request email.
BoxSignRequestCreateParams	setExternalId(String externalId) Sets the reference id in an external system that this sign request is related to.
BoxSignRequestCreateParams	setIsDocumentPreparationNeeded(boolean isDocumentPreparationNeeded) Sets the flag indicating if the sender should be taken into the builder flow to prepare the document.
BoxSignRequestCreateParams	setName(String name) Sets the name of this sign request.
BoxSignRequestCreateParams	setPrefillTags(List<BoxSignRequestPrefillTag> prefillTags) Sets the list of prefill tags.
BoxSignRequestCreateParams	setRedirectUrl(String redirectUrl) Sets the redirect URL that a signer will be redirected to after signing a document.
BoxSignRequestCreateParams	setSignatureColor(BoxSignRequestSignatureColor signatureColor) Sets the forced, specific color for the signature.
BoxSignRequestCreateParams	setTemplateId(String templateId) Sets the Sign Template ID will be use to create the sign request.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxSignRequestCreateParams

public BoxSignRequestCreateParams()

Method Detail

getIsDocumentPreparationNeeded

public boolean getIsDocumentPreparationNeeded()

Gets the flag indicating if the sender should be taken into the builder flow to prepare the document.

Returns:

true if document preparation is needed, otherwise false.

setIsDocumentPreparationNeeded

public BoxSignRequestCreateParams setIsDocumentPreparationNeeded(boolean isDocumentPreparationNeeded)

Sets the flag indicating if the sender should be taken into the builder flow to prepare the document.

Parameters:

isDocumentPreparationNeeded - whether or not sender should be taken into the builder flow to prepare the document.

Returns:

this BoxSignRequestCreateParams object for chaining.

getAreTextSignaturesEnabled

public boolean getAreTextSignaturesEnabled()

Gets the flag indicating if usage of signatures generated by typing (text) is enabled. Default is true.

Returns:

true if text signatures are enabled, otherwise false.

setAreTextSignaturesEnabled

public BoxSignRequestCreateParams setAreTextSignaturesEnabled(boolean areTextSignaturesEnabled)

Sets the flag indicating if usage of signatures generated by typing (text) is enabled. Default is true.

Parameters:

areTextSignaturesEnabled - indicating if text signatures are enabled for signers.

Returns:

this BoxSignRequestCreateParams object for chaining.

getAreDatesEnabled

public boolean getAreDatesEnabled()

Gets the flag indicating if ability for signer to add dates is enabled. Default is true.

Returns:

true if ability for signer to add dates is enabled, otherwise false.

setAreDatesEnabled

public BoxSignRequestCreateParams setAreDatesEnabled(boolean areDatesEnabled)

Sets the flag indicating if ability for signer to add dates is enabled. Default is true.

Parameters:

areDatesEnabled - indicating if ability for signer to add dates is enabled.

Returns:

this BoxSignRequestCreateParams object for chaining.

getSignatureColor

public BoxSignRequestSignatureColor getSignatureColor()

Gets the forced, specific color for the signature.

Returns:

signature color (blue, black, red).

setSignatureColor

public BoxSignRequestCreateParams setSignatureColor(BoxSignRequestSignatureColor signatureColor)

Sets the forced, specific color for the signature.

Parameters:

signatureColor - blue, black or red.

Returns:

this BoxSignRequestCreateParams object for chaining.

getEmailSubject

public String getEmailSubject()

Gets the subject of sign request email.

Returns:

subject of sign request email.

setEmailSubject

public BoxSignRequestCreateParams setEmailSubject(String emailSubject)

Sets the subject of sign request email. This is cleaned by sign request.

Parameters:

emailSubject - included in sign request email.

Returns:

this BoxSignRequestCreateParams object for chaining.

getEmailMessage

public String getEmailMessage()

Gets the message to include in sign request email.

Returns:

message of sign request email.

setEmailMessage

public BoxSignRequestCreateParams setEmailMessage(String emailMessage)

Sets the message to include in sign request email. This is cleaned,but some html tags are allowed. Links included in the message are also converted to actual links in the email. The message may contain the following html tags: 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.

Parameters:

emailMessage - included in sign request email.

Returns:

this BoxSignRequestCreateParams object for chaining.

getAreRemindersEnabled

public boolean getAreRemindersEnabled()

Gets the flag indicating if remind for signers to sign a document on day 3, 8, 13 and 18 (or less if the document has been digitally signed already) is enabled.

Returns:

true if reminders are enabled, otherwise false.

setAreRemindersEnabled

public BoxSignRequestCreateParams setAreRemindersEnabled(boolean areRemindersEnabled)

Sets the flag indicating if remind for signers to sign a document on day 3, 8, 13 and 18 (or less if the document has been digitally signed already) is enabled.

Parameters:

areRemindersEnabled - indicating if reminders are enabled.

Returns:

this BoxSignRequestCreateParams object for chaining.

getName

public String getName()

Gets the name of this sign request.

Returns:

name of this sign request.

setName

public BoxSignRequestCreateParams setName(String name)

Sets the name of this sign request.

Parameters:

name - of this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

getDaysValid

public int getDaysValid()

Gets the number of days after which this request will automatically expire if not completed.

Returns:

number of days after which this request will automatically expire if not completed.

setDaysValid

public BoxSignRequestCreateParams setDaysValid(int daysValid)

Sets the number of days after which this request will automatically expire if not completed.

Parameters:

daysValid - of this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

getExternalId

public String getExternalId()

Gets an ID that serve as reference in an external system that the sign request is related to.

Returns:

external id.

setExternalId

public BoxSignRequestCreateParams setExternalId(String externalId)

Sets the reference id in an external system that this sign request is related to.

Parameters:

externalId - of this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

getPrefillTags

public List<BoxSignRequestPrefillTag> getPrefillTags()

Gets the list of prefill tags.

Returns:

list of prefill tags.

setPrefillTags

public BoxSignRequestCreateParams setPrefillTags(List<BoxSignRequestPrefillTag> prefillTags)

Sets the list of prefill tags. When a document contains sign related tags in the content, you can prefill them using this prefillTags by referencing the 'id' of the tag as the externalId field of the prefill tag.

Parameters:

prefillTags - list for this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

getRedirectUrl

public String getRedirectUrl()

Gets the redirect URL that a signer will be redirected to after signing a document.

Returns:

redirect url.

setRedirectUrl

public BoxSignRequestCreateParams setRedirectUrl(String redirectUrl)

Sets the redirect URL that a signer will be redirected to after signing a document.

Parameters:

redirectUrl - of this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

getDeclinedRedirectUrl

public String getDeclinedRedirectUrl()

Gets the URL that a signer will be redirected to after declining to sign a document.

Returns:

decline redirect url.

setDeclinedRedirectUrl

public BoxSignRequestCreateParams setDeclinedRedirectUrl(String declinedRedirectUrl)

Sets the URL that a signer will be redirected to after declining to sign a document.

Parameters:

declinedRedirectUrl - of this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

getTemplateId

public String getTemplateId()

Gets the Sign Template ID of the Sign Request.

Returns:

template id.

setTemplateId

public BoxSignRequestCreateParams setTemplateId(String templateId)

Sets the Sign Template ID will be use to create the sign request.

Parameters:

templateId - for this sign request.

Returns:

this BoxSignRequestCreateParams object for chaining.

appendParamsAsJson

public void appendParamsAsJson(JsonObject requestJSON)

Used to append BoxSignRequestCreateParams to request.

Parameters:

requestJSON - request in json to append data to.