com.box.sdkgen.schemas.templatesignerinput

Class TemplateSignerInput

Object

NullableFieldTracker

SerializableObject

SignRequestPrefillTag

TemplateSignerInput

All Implemented Interfaces:

Serializable

public class TemplateSignerInput
extends SignRequestPrefillTag

Input created by a Signer on a Template.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateSignerInput.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumWrapper<TemplateSignerInputContentTypeField>	contentType Content type of input.
protected TemplateSignerInputCoordinatesField	coordinates Where the input is located on a page.
protected TemplateSignerInputDimensionsField	dimensions The size of the input.
protected String	documentId Document identifier.
protected List<String>	dropdownChoices When the input is of the type `dropdown` this values will be filled with all the dropdown options.
protected String	groupId When the input is of type `radio` they can be grouped to gather with this identifier.
protected Boolean	isRequired Whether or not the input is required.
protected String	label The label field is used especially for text, attachment, radio, and checkbox type inputs.
protected long	pageIndex Index of page that the input is on.
protected Boolean	readOnly Indicates whether this input is read-only (cannot be modified by signers).
protected EnumWrapper<TemplateSignerInputTypeField>	type Type of input.
protected SignRequestSignerInputValidation	validation Specifies the formatting rules that signers must follow for text field inputs.

Fields inherited from class SignRequestPrefillTag

checkboxValue, dateValue, documentTagId, textValue

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	TemplateSignerInput(long pageIndex)
protected	TemplateSignerInput(TemplateSignerInput.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
EnumWrapper<TemplateSignerInputContentTypeField>	getContentType()
TemplateSignerInputCoordinatesField	getCoordinates()
TemplateSignerInputDimensionsField	getDimensions()
String	getDocumentId()
List<String>	getDropdownChoices()
String	getGroupId()
Boolean	getIsRequired()
String	getLabel()
long	getPageIndex()
Boolean	getReadOnly()
EnumWrapper<TemplateSignerInputTypeField>	getType()
SignRequestSignerInputValidation	getValidation()
int	hashCode()
String	toString()

Methods inherited from class SignRequestPrefillTag

getCheckboxValue, getDateValue, getDocumentTagId, getTextValue

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<TemplateSignerInputTypeField> type

Type of input.

contentType

protected EnumWrapper<TemplateSignerInputContentTypeField> contentType

Content type of input.

isRequired

protected Boolean isRequired

Whether or not the input is required.

pageIndex

protected final long pageIndex

Index of page that the input is on.

documentId

protected String documentId

Document identifier.

dropdownChoices

protected List<String> dropdownChoices

When the input is of the type `dropdown` this values will be filled with all the dropdown options.

groupId

protected String groupId

When the input is of type `radio` they can be grouped to gather with this identifier.

coordinates

protected TemplateSignerInputCoordinatesField coordinates

Where the input is located on a page.

dimensions

protected TemplateSignerInputDimensionsField dimensions

The size of the input.

label

protected String label

The label field is used especially for text, attachment, radio, and checkbox type inputs.

readOnly

protected Boolean readOnly

Indicates whether this input is read-only (cannot be modified by signers).

validation

protected SignRequestSignerInputValidation validation

Specifies the formatting rules that signers must follow for text field inputs. If set, this validation is mandatory.

Constructor Detail

TemplateSignerInput

public TemplateSignerInput(long pageIndex)

TemplateSignerInput

protected TemplateSignerInput(TemplateSignerInput.Builder builder)

Method Detail

getType

public EnumWrapper<TemplateSignerInputTypeField> getType()

getContentType

public EnumWrapper<TemplateSignerInputContentTypeField> getContentType()

getIsRequired

public Boolean getIsRequired()

getPageIndex

public long getPageIndex()

getDocumentId

public String getDocumentId()

getDropdownChoices

public List<String> getDropdownChoices()

getGroupId

public String getGroupId()

getCoordinates

public TemplateSignerInputCoordinatesField getCoordinates()

getDimensions

public TemplateSignerInputDimensionsField getDimensions()

getLabel

public String getLabel()

getReadOnly

public Boolean getReadOnly()

getValidation

public SignRequestSignerInputValidation getValidation()

equals

public boolean equals(Object o)

Overrides:

equals in class SignRequestPrefillTag

hashCode

public int hashCode()

Overrides:

hashCode in class SignRequestPrefillTag

toString

public String toString()

Overrides:

toString in class SignRequestPrefillTag