com.box.sdk

Class BoxSignRequest.Info

Object

BoxJSONObject

BoxResource.Info

BoxSignRequest.Info

Enclosing class:

BoxSignRequest

public class BoxSignRequest.Info
extends BoxResource.Info

Contains information about the Sign Request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxSignRequest.Info.BoxSignRequestSignFiles List of files that will be signed, which are copies of the original source files.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
boolean	getAreDatesEnabled() Gets the flag indicating if ability for signer to add dates is enabled.
boolean	getAreRemindersEnabled() Gets the flag indicating if sending reminders 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.
Date	getAutoExpireAt() Uses days_valid to calculate the date and time that the sign request will expire, if unsigned.
Integer	getDaysValid() Gets the number of days after which this request will automatically expire if not completed.
String	getDeclinedRedirectUrl() Gets the URL that will be redirected to after the signer declines the sign request.
String	getEmailMessage() Gets the message to include in the sign request email.
String	getEmailSubject() Gets the subject of the sign request email.
String	getExternalId() Gets the reference id in an external system that this sign request is related to.
boolean	getIsDocumentPreparationNeeded() Indicates if the sender should receive a prepare_url in the response to complete document preparation via UI.
String	getName() Gets the name of this sign request.
BoxFolder.Info	getParentFolder() Gets the destination folder to place sign request specific data in (copy of source files, signing log etc.).
List<BoxSignRequestPrefillTag>	getPrefillTags() Gets the list of prefill tags.
String	getPrepareUrl() Gets the URL that can be used by the sign request sender to prepare the document through the UI.
String	getRedirectUrl() Gets the URL that will be redirected to after the signer completes the sign request.
BoxSignRequest	getResource() Gets the resource associated with this Info.
BoxSignRequestSignatureColor	getSignatureColor() Gets the forced, specific color for the signature.
List<BoxSignRequestSigner>	getSigners() Gets the list of signers for this sign request.
BoxSignRequest.Info.BoxSignRequestSignFiles	getSignFiles() List of files that will be signed, which are copies of the original source files.
BoxFile.Info	getSigningLog() Gets the reference to a file that will hold a log of all signer activity for this request.
List<BoxFile.Info>	getSourceFiles() Gets the list of files to create a signing document from.
BoxSignRequest.BoxSignRequestStatus	getStatus() Gets the status of the sign request.
String	getTemplateId() Gets the id of the template that was used to create this sign request.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getIsDocumentPreparationNeeded

public boolean getIsDocumentPreparationNeeded()

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

Returns:

true if document preparation is needed, otherwise false.

getAreTextSignaturesEnabled

public boolean getAreTextSignaturesEnabled()

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

Returns:

true if text signatures are enabled, otherwise false.

getAreDatesEnabled

public boolean getAreDatesEnabled()

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

Returns:

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

getSignatureColor

public BoxSignRequestSignatureColor getSignatureColor()

Gets the forced, specific color for the signature.

Returns:

signature color (blue, black, red).

getEmailSubject

public String getEmailSubject()

Gets the subject of the sign request email.

Returns:

subject of the sign request email.

getEmailMessage

public String getEmailMessage()

Gets the message to include in the sign request email.

Returns:

message of sign request email.

getAreRemindersEnabled

public boolean getAreRemindersEnabled()

Gets the flag indicating if sending reminders 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.

getSourceFiles

public List<BoxFile.Info> getSourceFiles()

Gets the list of files to create a signing document from.

Returns:

list of files to create a signing document from.

getParentFolder

public BoxFolder.Info getParentFolder()

Gets the destination folder to place sign request specific data in (copy of source files, signing log etc.).

Returns:

destination folder to place sign request specific data in.

getSigners

public List<BoxSignRequestSigner> getSigners()

Gets the list of signers for this sign request.

Returns:

list of signers for this sign request.

getName

public String getName()

Gets the name of this sign request.

Returns:

name of this sign request.

getPrefillTags

public List<BoxSignRequestPrefillTag> getPrefillTags()

Gets the list of prefill tags.

Returns:

list of prefill tags.

getDaysValid

public Integer 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.

getExternalId

public String getExternalId()

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

Returns:

external id.

getPrepareUrl

public String getPrepareUrl()

Gets the URL that can be used by the sign request sender to prepare the document through the UI.

Returns:

prepare url.

getSigningLog

public BoxFile.Info getSigningLog()

Gets the reference to a file that will hold a log of all signer activity for this request.

Returns:

signing log.

getStatus

public BoxSignRequest.BoxSignRequestStatus getStatus()

Gets the status of the sign request.

Returns:

sign request's status.

getSignFiles

public BoxSignRequest.Info.BoxSignRequestSignFiles getSignFiles()

List of files that will be signed, which are copies of the original source files. A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

Returns:

sign files.

getAutoExpireAt

public Date getAutoExpireAt()

Uses days_valid to calculate the date and time that the sign request will expire, if unsigned.

Returns:

auto expires at date.

getRedirectUrl

public String getRedirectUrl()

Gets the URL that will be redirected to after the signer completes the sign request.

Returns:

redirect url.

getDeclinedRedirectUrl

public String getDeclinedRedirectUrl()

Gets the URL that will be redirected to after the signer declines the sign request.

Returns:

declined redirect url.

getTemplateId

public String getTemplateId()

Gets the id of the template that was used to create this sign request.

Returns:

sign template id.

getResource

public BoxSignRequest getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.