com.box.sdkgen.schemas.signrequestsignerinput

Class SignRequestSignerInput

Object

NullableFieldTracker

SerializableObject

SignRequestPrefillTag

SignRequestSignerInput

All Implemented Interfaces:

Serializable

public class SignRequestSignerInput
extends SignRequestPrefillTag

Input created by a Signer on a Sign Request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignRequestSignerInput.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumWrapper<SignRequestSignerInputContentTypeField>	contentType Content type of input.
protected Boolean	isValidated Indicates whether the signer's input has been validated through re-authentication.
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 String	reason The reason for the signer's input, applicable to signature or initial content types in a `cfr11` request flow.
protected EnumWrapper<SignRequestSignerInputTypeField>	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
	SignRequestSignerInput(long pageIndex)
protected	SignRequestSignerInput(SignRequestSignerInput.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
EnumWrapper<SignRequestSignerInputContentTypeField>	getContentType()
Boolean	getIsValidated()
long	getPageIndex()
Boolean	getReadOnly()
String	getReason()
EnumWrapper<SignRequestSignerInputTypeField>	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<SignRequestSignerInputTypeField> type

Type of input.

contentType

protected EnumWrapper<SignRequestSignerInputContentTypeField> contentType

Content type of input.

pageIndex

protected final long pageIndex

Index of page that the input is on.

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.

reason

protected String reason

The reason for the signer's input, applicable to signature or initial content types in a `cfr11` request flow. The value is `null` when not applicable.

isValidated

protected Boolean isValidated

Indicates whether the signer's input has been validated through re-authentication. Applicable only for signature or initial content types in a `cfr11` request flow. The value is `null` for standard request flows or non-applicable input types.

Constructor Detail

SignRequestSignerInput

public SignRequestSignerInput(long pageIndex)

SignRequestSignerInput

protected SignRequestSignerInput(SignRequestSignerInput.Builder builder)

Method Detail

getType

public EnumWrapper<SignRequestSignerInputTypeField> getType()

getContentType

public EnumWrapper<SignRequestSignerInputContentTypeField> getContentType()

getPageIndex

public long getPageIndex()

getReadOnly

public Boolean getReadOnly()

getValidation

public SignRequestSignerInputValidation getValidation()

getReason

public String getReason()

getIsValidated

public Boolean getIsValidated()

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