SignRequestCreateSigner (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - SignRequestCreateSigner

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SignRequestSigner
```
public class SignRequestCreateSigner
extends SerializableObject
```
The schema for a Signer object used in for creating a Box Sign request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SignRequestCreateSigner.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`declinedRedirectUrl` The URL that a signer will be redirect to after declining to sign a document.
`protected String`	`email` Email address of the signer.
`protected String`	`embedUrlExternalUserId` User ID for the signer in an external application responsible for authentication when accessing the embed URL.
`protected Boolean`	`isInPerson` Used in combination with an embed URL for a sender.
`protected String`	`language` The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
`protected Boolean`	`loginRequired` If set to true, the signer will need to log in to a Box account before signing the request.
`protected Long`	`order` Order of the signer.
`protected String`	`password` If set, the signer is required to enter the password before they are able to sign a document.
`protected String`	`redirectUrl` The URL that a signer will be redirected to after signing a document.
`protected EnumWrapper<SignRequestCreateSignerRoleField>`	`role` Defines the role of the signer in the signature request.
`protected String`	`signerGroupId` If set, signers who have the same value will be assigned to the same input and to the same signer group.
`protected Boolean`	`suppressNotifications` If true, no emails about the sign request will be sent.
`protected String`	`verificationPhoneNumber` If set, this phone number will be used to verify the signer via two-factor authentication before they are able to sign the document.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

SignRequestCreateSigner()

protected SignRequestCreateSigner(SignRequestCreateSigner.Builder builder)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getDeclinedRedirectUrl()`
`String`	`getEmail()`
`String`	`getEmbedUrlExternalUserId()`
`Boolean`	`getIsInPerson()`
`String`	`getLanguage()`
`Boolean`	`getLoginRequired()`
`Long`	`getOrder()`
`String`	`getPassword()`
`String`	`getRedirectUrl()`
`EnumWrapper<SignRequestCreateSignerRoleField>`	`getRole()`
`String`	`getSignerGroupId()`
`Boolean`	`getSuppressNotifications()`
`String`	`getVerificationPhoneNumber()`
`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
  - email
```
protected String email
```
    Email address of the signer. The email address of the signer is required when making signature requests, except when using templates that are configured to include emails.
  - role
```
protected EnumWrapper<SignRequestCreateSignerRoleField> role
```
    Defines the role of the signer in the signature request. A `signer` must sign the document and an `approver` must approve the document. A `final_copy_reader` 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 are redirected to the next `in_person` signer.
  - order
```
protected Long order
```
    Order of the signer.
  - embedUrlExternalUserId
```
protected String embedUrlExternalUserId
```
    User ID for the signer in an external application responsible for authentication when accessing the embed URL.
  - redirectUrl
```
protected String redirectUrl
```
    The URL that a signer will be redirected to after signing a document. Defining this URL overrides default or global redirect URL settings for a specific signer. If no declined redirect URL is specified, this URL will be used for decline actions as well.
  - declinedRedirectUrl
```
protected String declinedRedirectUrl
```
    The URL that a signer will be redirect to after declining to sign a document. Defining this URL overrides default or global declined redirect URL settings for a specific signer.
  - loginRequired
```
protected Boolean loginRequired
```
    If set to true, the signer will need to log in to a Box account before signing the request. If the signer does not have an existing account, they will have the option to create a free Box account.
  - verificationPhoneNumber
```
protected String verificationPhoneNumber
```
    If set, this phone number will be used to verify the signer via two-factor authentication before they are able to sign the document. Cannot be selected in combination with `login_required`.
  - password
```
protected String password
```
    If set, the signer is required to enter the password before they are able to sign a document. This field is write only.
  - signerGroupId
```
protected String signerGroupId
```
    If set, signers who have the same value will be assigned to the same input and to the same signer group. A signer group is not a Box Group. It is an entity that belongs to a Sign Request and can only be used/accessed within this Sign Request. A signer group is expected to have more than one signer. If the provided value is only used for one signer, this value will be ignored and request will be handled as it was intended for an individual signer. The value provided can be any string and only used to determine which signers belongs to same group. A successful response will provide a generated UUID value instead for signers in the same signer group.
  - suppressNotifications
```
protected Boolean suppressNotifications
```
    If true, no emails about the sign request will be sent.
  - language
```
protected String language
```
    The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
- Constructor Detail
  - SignRequestCreateSigner
```
public SignRequestCreateSigner()
```
  - SignRequestCreateSigner
```
protected SignRequestCreateSigner(SignRequestCreateSigner.Builder builder)
```
- Method Detail
  - getEmail
```
public String getEmail()
```
  - getRole
```
public EnumWrapper<SignRequestCreateSignerRoleField> getRole()
```
  - getIsInPerson
```
public Boolean getIsInPerson()
```
  - getOrder
```
public Long getOrder()
```
  - getEmbedUrlExternalUserId
```
public String getEmbedUrlExternalUserId()
```
  - getRedirectUrl
```
public String getRedirectUrl()
```
  - getDeclinedRedirectUrl
```
public String getDeclinedRedirectUrl()
```
  - getLoginRequired
```
public Boolean getLoginRequired()
```
  - getVerificationPhoneNumber
```
public String getVerificationPhoneNumber()
```
  - getPassword
```
public String getPassword()
```
  - getSignerGroupId
```
public String getSignerGroupId()
```
  - getSuppressNotifications
```
public Boolean getSuppressNotifications()
```
  - getLanguage
```
public String getLanguage()
```
  - 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 SignRequestCreateSigner

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

email

role

isInPerson

order

embedUrlExternalUserId

redirectUrl

declinedRedirectUrl

loginRequired

verificationPhoneNumber

password

signerGroupId

suppressNotifications

language

Constructor Detail

SignRequestCreateSigner

SignRequestCreateSigner

Method Detail

getEmail

getRole

getIsInPerson

getOrder

getEmbedUrlExternalUserId

getRedirectUrl

getDeclinedRedirectUrl

getLoginRequired

getVerificationPhoneNumber

getPassword

getSignerGroupId

getSuppressNotifications

getLanguage

equals

hashCode

toString