com.box.sdk

Class BoxSignTemplate.Info

Object

BoxJSONObject

BoxResource.Info

BoxSignTemplate.Info

Enclosing class:

BoxSignTemplate

public class BoxSignTemplate.Info
extends BoxResource.Info

Contains information about a BoxSignTemplate.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object with the provided JSON string.

Method Summary

Modifier and Type	Method and Description
BoxSignTemplateAdditionalInfo	getAdditionalInfo() Gets the additional information about this Sign Template.
boolean	getAreEmailSettingsLocked() Gets whether the templates email settings are editable or not.
boolean	getAreFieldsLocked() Gets whether the templates input fields are editable or not.
boolean	getAreFilesLocked() Gets whether the template document options are editable or not, for example renaming the document.
boolean	getAreOptionsLocked() Gets weather the templates input options are editable or not.
boolean	getAreRecipientsLocked() Gets whether the template signers are editable or not.
BoxSignTemplateCustomBranding	getCustomBranding() Gets the custom branding applied to notifications and signature requests.
Integer	getDaysValid() Gets the number of days after which the created signature request will automatically expire if not completed.
String	getEmailMessage() Gets the email message that will be sent to all signers.
String	getEmailSubject() Gets the email subject that will be sent to all signers.
String	getName() Gets the name of this Sign Template.
BoxFolder.Info	getParentFolder() Gets the parent folder of this Sign Template.
BoxSignTemplateReadySignLink	getReadySignLink() Gets the ready sign link for this Sign Template.
BoxSignTemplate	getResource() Gets the resource associated with this Info.
List<BoxSignTemplateSigner>	getSigners() Gets the signers for this Sign Template.
List<BoxFile.Info>	getSourceFiles() Gets the source files for this Sign Template.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

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 with the provided JSON string.

Parameters:

json - the JSON string representing the Sign Template.

Method Detail

getResource

public BoxSignTemplate getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getAdditionalInfo

public BoxSignTemplateAdditionalInfo getAdditionalInfo()

Gets the additional information about this Sign Template.

Returns:

the additional information about this Sign Template.

getAreEmailSettingsLocked

public boolean getAreEmailSettingsLocked()

Gets whether the templates email settings are editable or not.

Returns:

true if the email settings are locked; otherwise false.

getAreFieldsLocked

public boolean getAreFieldsLocked()

Gets whether the templates input fields are editable or not. This includes deleting or renaming template files.

Returns:

true if the fields are locked; otherwise false.

getAreOptionsLocked

public boolean getAreOptionsLocked()

Gets weather the templates input options are editable or not.

Returns:

true if the options are editable; otherwise false.

getAreFilesLocked

public boolean getAreFilesLocked()

Gets whether the template document options are editable or not, for example renaming the document.

Returns:

true if the files are locked; otherwise false.

getAreRecipientsLocked

public boolean getAreRecipientsLocked()

Gets whether the template signers are editable or not.

Returns:

true if the recipients are locked; otherwise false.

getCustomBranding

public BoxSignTemplateCustomBranding getCustomBranding()

Gets the custom branding applied to notifications and signature requests.

Returns:

the custom branding for this Sign Template.

getDaysValid

public Integer getDaysValid()

Gets 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.

Returns:

the number of days the template is valid for.

getEmailMessage

public String getEmailMessage()

Gets the email message that will be sent to all signers.

Returns:

the email message for this Sign Template.

getEmailSubject

public String getEmailSubject()

Gets the email subject that will be sent to all signers.

Returns:

the email subject for this Sign Template.

getName

public String getName()

Gets the name of this Sign Template.

Returns:

the name of this Sign Template.

getParentFolder

public BoxFolder.Info getParentFolder()

Gets the parent folder of this Sign Template.

Returns:

the parent folder of this Sign Template.

getReadySignLink

public BoxSignTemplateReadySignLink getReadySignLink()

Gets the ready sign link for this Sign Template.

Returns:

the ready sign link for this Sign Template.

getSigners

public List<BoxSignTemplateSigner> getSigners()

Gets the signers for this Sign Template.

Returns:

the signers for this Sign Template.

getSourceFiles

public List<BoxFile.Info> getSourceFiles()

Gets the source files for this Sign Template.

Returns:

the source files for this Sign Template.