SignTemplate (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - SignTemplate

All Implemented Interfaces:

Serializable
```
public class SignTemplate
extends SerializableObject
```
A Box Sign template object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SignTemplate.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SignTemplate.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected SignTemplateAdditionalInfoField`	`additionalInfo` Additional information on which fields are required and which fields are not editable.
`protected Boolean`	`areEmailSettingsLocked` Indicates if the template email settings are editable or not.
`protected Boolean`	`areFieldsLocked` Indicates if the template input fields are editable or not.
`protected Boolean`	`areFilesLocked` Indicates if the template files are editable or not.
`protected Boolean`	`areOptionsLocked` Indicates if the template document options are editable or not, for example renaming the document.
`protected Boolean`	`areRecipientsLocked` Indicates if the template signers are editable or not.
`protected SignTemplateCustomBrandingField`	`customBranding` Custom branding applied to notifications and signature requests.
`protected Long`	`daysValid` Set the number of days after which the created signature request will automatically expire if not completed.
`protected String`	`emailMessage` Message to include in signature request email.
`protected String`	`emailSubject` Subject of signature request email.
`protected String`	`id` Template identifier.
`protected String`	`name` The name of the template.
`protected FolderMini`	`parentFolder`
`protected SignTemplateReadySignLinkField`	`readySignLink` Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template.
`protected List<TemplateSigner>`	`signers` Array of signers for the template.
`protected List<FileMini>`	`sourceFiles` List of files to create a signing document from.
`protected EnumWrapper<SignTemplateTypeField>`	`type` The value will always be `sign-template`.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

SignTemplate()

protected SignTemplate(SignTemplate.Builder builder)

Constructors
Modifier	Constructor and Description
	`SignTemplate()`
`protected`	`SignTemplate(SignTemplate.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`SignTemplateAdditionalInfoField`	`getAdditionalInfo()`
`Boolean`	`getAreEmailSettingsLocked()`
`Boolean`	`getAreFieldsLocked()`
`Boolean`	`getAreFilesLocked()`
`Boolean`	`getAreOptionsLocked()`
`Boolean`	`getAreRecipientsLocked()`
`SignTemplateCustomBrandingField`	`getCustomBranding()`
`Long`	`getDaysValid()`
`String`	`getEmailMessage()`
`String`	`getEmailSubject()`
`String`	`getId()`
`String`	`getName()`
`FolderMini`	`getParentFolder()`
`SignTemplateReadySignLinkField`	`getReadySignLink()`
`List<TemplateSigner>`	`getSigners()`
`List<FileMini>`	`getSourceFiles()`
`EnumWrapper<SignTemplateTypeField>`	`getType()`
`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
  - type
```
protected EnumWrapper<SignTemplateTypeField> type
```
    The value will always be `sign-template`.
  - id
```
protected String id
```
    Template identifier.
  - name
```
protected String name
```
    The name of the template.
  - emailSubject
```
protected String emailSubject
```
    Subject of signature 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 signature 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.
  - 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.
  - parentFolder
```
protected FolderMini parentFolder
```
  - sourceFiles
```
protected List<FileMini> sourceFiles
```
    List of files to create a signing document from. Only the ID and type fields are required for each file.
  - areFieldsLocked
```
protected Boolean areFieldsLocked
```
    Indicates if the template input fields are editable or not.
  - areOptionsLocked
```
protected Boolean areOptionsLocked
```
    Indicates if the template document options are editable or not, for example renaming the document.
  - areRecipientsLocked
```
protected Boolean areRecipientsLocked
```
    Indicates if the template signers are editable or not.
  - areEmailSettingsLocked
```
protected Boolean areEmailSettingsLocked
```
    Indicates if the template email settings are editable or not.
  - areFilesLocked
```
protected Boolean areFilesLocked
```
    Indicates if the template files are editable or not. This includes deleting or renaming template files.
  - signers
```
protected List<TemplateSigner> signers
```
    Array of signers for the template.
    **Note**: It may happen that some signers specified in the template belong to conflicting [segments](https://developer.box.com/reference/resources/shield-information-barrier-segment-member) (user groups). This means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts. In such a case, an attempt to send a sign request based on a template that lists signers in conflicting segments will result in an error.
    Read more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
  - additionalInfo
```
protected SignTemplateAdditionalInfoField additionalInfo
```
    Additional information on which fields are required and which fields are not editable.
  - readySignLink
```
protected SignTemplateReadySignLinkField readySignLink
```
    Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template. Use this link when you want to post a signature request on a public form — such as an email, social media post, or web page — without knowing who the signers will be. Note: The ready-sign link feature is limited to Enterprise Plus customers and not available to Box Verified Enterprises.
  - customBranding
```
protected SignTemplateCustomBrandingField customBranding
```
    Custom branding applied to notifications and signature requests.
- Constructor Detail
  - SignTemplate
```
public SignTemplate()
```
  - SignTemplate
```
protected SignTemplate(SignTemplate.Builder builder)
```
- Method Detail
  - getType
```
public EnumWrapper<SignTemplateTypeField> getType()
```
  - getId
```
public String getId()
```
  - getName
```
public String getName()
```
  - getEmailSubject
```
public String getEmailSubject()
```
  - getEmailMessage
```
public String getEmailMessage()
```
  - getDaysValid
```
public Long getDaysValid()
```
  - getParentFolder
```
public FolderMini getParentFolder()
```
  - getSourceFiles
```
public List<FileMini> getSourceFiles()
```
  - getAreFieldsLocked
```
public Boolean getAreFieldsLocked()
```
  - getAreOptionsLocked
```
public Boolean getAreOptionsLocked()
```
  - getAreRecipientsLocked
```
public Boolean getAreRecipientsLocked()
```
  - getAreEmailSettingsLocked
```
public Boolean getAreEmailSettingsLocked()
```
  - getAreFilesLocked
```
public Boolean getAreFilesLocked()
```
  - getSigners
```
public List<TemplateSigner> getSigners()
```
  - getAdditionalInfo
```
public SignTemplateAdditionalInfoField getAdditionalInfo()
```
  - getReadySignLink
```
public SignTemplateReadySignLinkField getReadySignLink()
```
  - getCustomBranding
```
public SignTemplateCustomBrandingField getCustomBranding()
```
  - 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

Class SignTemplate

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

type

id

name

emailSubject

emailMessage

daysValid

parentFolder

sourceFiles

areFieldsLocked

areOptionsLocked

areRecipientsLocked

areEmailSettingsLocked

areFilesLocked

signers

additionalInfo

readySignLink

customBranding

Constructor Detail

SignTemplate

SignTemplate

Method Detail

getType

getId

getName

getEmailSubject

getEmailMessage

getDaysValid

getParentFolder

getSourceFiles

getAreFieldsLocked

getAreOptionsLocked

getAreRecipientsLocked

getAreEmailSettingsLocked

getAreFilesLocked

getSigners

getAdditionalInfo

getReadySignLink

getCustomBranding

equals

hashCode

toString