TemplateSigner (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - TemplateSigner

All Implemented Interfaces:

Serializable
```
public class TemplateSigner
extends SerializableObject
```
The schema for a Signer for Templates.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TemplateSigner.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`email` Email address of the signer.
`protected List<TemplateSignerInput>`	`inputs`
`protected Boolean`	`isInPerson` Used in combination with an embed URL for a sender.
`protected Boolean`	`isPasswordRequired` If true for signers with a defined email, the password provided when the template was created is used by default.
`protected Boolean`	`isPhoneNumberRequired` If true for signers with a defined email, the phone number provided when the template was created is used by default.
`protected String`	`label` A placeholder label for the signer set by the template creator to differentiate between signers.
`protected Boolean`	`loginRequired` If true, the signer is required to login to access the document.
`protected Long`	`order` Order of the signer.
`protected String`	`publicId` An identifier for the signer.
`protected EnumWrapper<TemplateSignerRoleField>`	`role` Defines the role of the signer in the signature request.
`protected String`	`signerGroupId` If provided, this value points signers that are assigned the same inputs and belongs to same signer group.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

TemplateSigner()

protected TemplateSigner(TemplateSigner.Builder builder)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getEmail()`
`List<TemplateSignerInput>`	`getInputs()`
`Boolean`	`getIsInPerson()`
`Boolean`	`getIsPasswordRequired()`
`Boolean`	`getIsPhoneNumberRequired()`
`String`	`getLabel()`
`Boolean`	`getLoginRequired()`
`Long`	`getOrder()`
`String`	`getPublicId()`
`EnumWrapper<TemplateSignerRoleField>`	`getRole()`
`String`	`getSignerGroupId()`
`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
  - inputs
```
protected List<TemplateSignerInput> inputs
```
  - email
```
protected String email
```
    Email address of the signer.
  - role
```
protected EnumWrapper<TemplateSignerRoleField> role
```
    Defines the role of the signer in the signature request. A role of `signer` needs to sign the document, a role `approver` approves the document and a `final_copy_reader` role only receives the final signed document and signing log.
  - isInPerson
```
protected Boolean isInPerson
```
    Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next `in_person` signer.
  - order
```
protected Long order
```
    Order of the signer.
  - signerGroupId
```
protected String signerGroupId
```
    If provided, this value points signers that are assigned the same inputs and belongs to same signer group. A signer group is not a Box Group. It is an entity that belongs to the template itself and can only be used within Box Sign requests created from it.
  - label
```
protected String label
```
    A placeholder label for the signer set by the template creator to differentiate between signers.
  - publicId
```
protected String publicId
```
    An identifier for the signer. This can be used to identify a signer within the template.
  - isPasswordRequired
```
protected Boolean isPasswordRequired
```
    If true for signers with a defined email, the password provided when the template was created is used by default. If true for signers without a specified / defined email, the creator needs to provide a password when using the template.
  - isPhoneNumberRequired
```
protected Boolean isPhoneNumberRequired
```
    If true for signers with a defined email, the phone number provided when the template was created is used by default. If true for signers without a specified / defined email, the template creator needs to provide a phone number when creating a request.
  - loginRequired
```
protected Boolean loginRequired
```
    If true, the signer is required to login to access the document.
- Constructor Detail
  - TemplateSigner
```
public TemplateSigner()
```
  - TemplateSigner
```
protected TemplateSigner(TemplateSigner.Builder builder)
```
- Method Detail
  - getInputs
```
public List<TemplateSignerInput> getInputs()
```
  - getEmail
```
public String getEmail()
```
  - getRole
```
public EnumWrapper<TemplateSignerRoleField> getRole()
```
  - getIsInPerson
```
public Boolean getIsInPerson()
```
  - getOrder
```
public Long getOrder()
```
  - getSignerGroupId
```
public String getSignerGroupId()
```
  - getLabel
```
public String getLabel()
```
  - getPublicId
```
public String getPublicId()
```
  - getIsPasswordRequired
```
public Boolean getIsPasswordRequired()
```
  - getIsPhoneNumberRequired
```
public Boolean getIsPhoneNumberRequired()
```
  - getLoginRequired
```
public Boolean getLoginRequired()
```
  - 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 TemplateSigner

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

inputs

email

role

isInPerson

order

signerGroupId

label

publicId

isPasswordRequired

isPhoneNumberRequired

loginRequired

Constructor Detail

TemplateSigner

TemplateSigner

Method Detail

getInputs

getEmail

getRole

getIsInPerson

getOrder

getSignerGroupId

getLabel

getPublicId

getIsPasswordRequired

getIsPhoneNumberRequired

getLoginRequired

equals

hashCode

toString