com.box.sdkgen.schemas.signrequestcreaterequest

Class SignRequestCreateRequest

Object

NullableFieldTracker

SerializableObject

SignRequestBase

SignRequestCreateRequest

All Implemented Interfaces:

Serializable

public class SignRequestCreateRequest
extends SignRequestBase

Creates a Box Sign request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignRequestCreateRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected FolderMini	parentFolder
protected EnumWrapper<SignRequestCreateRequestSignatureColorField>	signatureColor Force a specific color for the signature (blue, black, or red).
protected List<SignRequestCreateSigner>	signers Array of signers for the signature request.
protected List<FileBase>	sourceFiles List of files to create a signing document from.

Fields inherited from class SignRequestBase

areRemindersEnabled, areTextSignaturesEnabled, daysValid, declinedRedirectUrl, emailMessage, emailSubject, externalId, externalSystemName, isDocumentPreparationNeeded, name, prefillTags, redirectUrl, templateId

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	SignRequestCreateRequest(List<SignRequestCreateSigner> signers)
protected	SignRequestCreateRequest(SignRequestCreateRequest.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
FolderMini	getParentFolder()
EnumWrapper<SignRequestCreateRequestSignatureColorField>	getSignatureColor()
List<SignRequestCreateSigner>	getSigners()
List<FileBase>	getSourceFiles()
int	hashCode()
String	toString()

Methods inherited from class SignRequestBase

getAreRemindersEnabled, getAreTextSignaturesEnabled, getDaysValid, getDeclinedRedirectUrl, getEmailMessage, getEmailSubject, getExternalId, getExternalSystemName, getIsDocumentPreparationNeeded, getName, getPrefillTags, getRedirectUrl, getTemplateId

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

sourceFiles

protected List<FileBase> sourceFiles

List of files to create a signing document from. This is currently limited to ten files. Only the ID and type fields are required for each file.

signatureColor

protected EnumWrapper<SignRequestCreateRequestSignatureColorField> signatureColor

Force a specific color for the signature (blue, black, or red).

signers

protected final List<SignRequestCreateSigner> signers

Array of signers for the signature request. 35 is the max number of signers permitted.

**Note**: It may happen that some signers 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 the sign request 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).

parentFolder

protected FolderMini parentFolder

Constructor Detail

SignRequestCreateRequest

public SignRequestCreateRequest(List<SignRequestCreateSigner> signers)

SignRequestCreateRequest

protected SignRequestCreateRequest(SignRequestCreateRequest.Builder builder)

Method Detail

getSourceFiles

public List<FileBase> getSourceFiles()

getSignatureColor

public EnumWrapper<SignRequestCreateRequestSignatureColorField> getSignatureColor()

getSigners

public List<SignRequestCreateSigner> getSigners()

getParentFolder

public FolderMini getParentFolder()

equals

public boolean equals(Object o)

Overrides:

equals in class SignRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class SignRequestBase

toString

public String toString()

Overrides:

toString in class SignRequestBase