com.box.sdk

Class BoxSignRequestPrefillTag

Object

BoxJSONObject

BoxSignRequestPrefillTag

public class BoxSignRequestPrefillTag
extends BoxJSONObject

Represents a prefill tag used in BoxSignRequest. When a document contains sign related tags in the content, you can prefill them using this prefillTag by referencing the 'id' of the tag as the externalId field of the prefill tag.

Constructor Summary

Constructors

Constructor and Description
BoxSignRequestPrefillTag(String json) Constructs a BoxSignRequestPrefillTag from a JSON string.
BoxSignRequestPrefillTag(String documentTagId, Boolean checkboxValue) Constructs a BoxSignRequestPrefillTag with checkbox prefill value.
BoxSignRequestPrefillTag(String documentTagId, Date dateValue) Constructs a BoxSignRequestPrefillTag with date prefill value.
BoxSignRequestPrefillTag(String documentTagId, String textValue) Constructs a BoxSignRequestPrefillTag with text prefill value.

Method Summary

Modifier and Type	Method and Description
Boolean	getCheckboxValue() Gets the checkbox prefill value.
Date	getDateValue() Gets the date prefill value.
String	getDocumentTagId() Gets the reference id of a particular tag added to the content of the files being used to create the sign request.
JsonObject	getJSONObject() Gets a JSON object representing this class.
String	getTextValue() Gets the text prefill value.

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxSignRequestPrefillTag

public BoxSignRequestPrefillTag(String documentTagId,
                                String textValue)

Constructs a BoxSignRequestPrefillTag with text prefill value.

Parameters:

documentTagId - if of the tag.

textValue - text prefill value.

BoxSignRequestPrefillTag

public BoxSignRequestPrefillTag(String documentTagId,
                                Boolean checkboxValue)

Constructs a BoxSignRequestPrefillTag with checkbox prefill value.

Parameters:

documentTagId - if of the tag.

checkboxValue - checkbox prefill value.

BoxSignRequestPrefillTag

public BoxSignRequestPrefillTag(String documentTagId,
                                Date dateValue)

Constructs a BoxSignRequestPrefillTag with date prefill value.

Parameters:

documentTagId - if of the tag.

dateValue - date prefill value.

BoxSignRequestPrefillTag

public BoxSignRequestPrefillTag(String json)

Constructs a BoxSignRequestPrefillTag from a JSON string.

Parameters:

json - the JSON encoded enterprise.

Method Detail

getDocumentTagId

public String getDocumentTagId()

Gets the reference id of a particular tag added to the content of the files being used to create the sign request.

Returns:

document tag id.

getTextValue

public String getTextValue()

Gets the text prefill value.

Returns:

text prefill value.

getCheckboxValue

public Boolean getCheckboxValue()

Gets the checkbox prefill value.

Returns:

checkbox prefill value.

getDateValue

public Date getDateValue()

Gets the date prefill value.

Returns:

date prefill value.

getJSONObject

public JsonObject getJSONObject()

Gets a JSON object representing this class.

Returns:

the JSON object representing this class.