com.box.sdk

Class BoxSignRequestSigner

Object

BoxJSONObject

BoxSignRequestSigner

public class BoxSignRequestSigner
extends BoxJSONObject

Represents a signer in BoxSignRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxSignRequestSigner.BoxSignerDecision Represents a final decision made by signer (type and time the decision was made).
class	BoxSignRequestSigner.BoxSignerInput Represents an input created by a signer on a sign request.
static class	BoxSignRequestSigner.BoxSignRequestInputType Represents a type of input.
static class	BoxSignRequestSigner.BoxSignRequestSignerDecisionType Type of decision made by signer.

Constructor Summary

Constructors

Constructor and Description
BoxSignRequestSigner(JsonObject jsonObject, BoxAPIConnection api) Construct a BoxSignRequestSigner.
BoxSignRequestSigner(String email) Constructs a BoxSignRequestSigner with an email.

Method Summary

Modifier and Type	Method and Description
String	getEmail() Gets the email address of the signer.
String	getEmbedUrl() Gets the url to direct signer to for signing.
String	getEmbedUrlExternalUserId() Gets the user id for this signer in external application responsible for authentication when accessing the embed url.
boolean	getHasViewedDocument() Gets the flag indicating if signer has viewed the document.
boolean	getHasViewedEmail() Gets the flag indicating if signer has viewed the sign request email.
Boolean	getInPerson() Gets the flag that is used in combination with an embed url for a the sender.
List<BoxSignRequestSigner.BoxSignerInput>	getInputs() Gets the inputs created by a signer on a sign request.
boolean	getIsInPerson() Gets the flag that when used in combination with an embed url on the sender.
JsonObject	getJSONObject() Gets a JSON object representing this class.
int	getOrder() Gets the order of signer.
BoxSignRequestSignerRole	getRole() Gets the role of the signer.
BoxSignRequestSigner.BoxSignerDecision	getSignerDecision() Gets the final decision made by signer.
BoxSignRequestSigner	setEmail(String email) Sets the email address of the signer.
BoxSignRequestSigner	setEmbedUrlExternalUserId(String embedUrlExternalUserId) Sets the user id for this signer in external application responsible for authentication when accessing the embed url.
BoxSignRequestSigner	setInPerson(Boolean isInPerson) Sets the flag that is used in combination with an embed url for a the sender.
BoxSignRequestSigner	setOrder(Integer order) Sets the order of signer.
BoxSignRequestSigner	setRole(BoxSignRequestSignerRole role) Sets the role of the signer.

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

BoxSignRequestSigner

public BoxSignRequestSigner(String email)

Constructs a BoxSignRequestSigner with an email.

Parameters:

email - of signer.

BoxSignRequestSigner

public BoxSignRequestSigner(JsonObject jsonObject,
                            BoxAPIConnection api)

Construct a BoxSignRequestSigner.

Parameters:

jsonObject - the parsed JSON object.

api - the API connection to be used to fetch interacted item

Method Detail

getEmail

public String getEmail()

Gets the email address of the signer.

Returns:

email address of the signer.

getRole

public BoxSignRequestSignerRole getRole()

Gets the role of the signer.

Returns:

role of the signer.

getIsInPerson

public boolean getIsInPerson()

Gets the flag that when used in combination with an embed url on the sender. After the sender signs, they will be redirected to the next InPerson signer.

Returns:

true if is in person signer, otherwise false.

getOrder

public int getOrder()

Gets the order of signer.

Returns:

order of signer.

getEmbedUrlExternalUserId

public String getEmbedUrlExternalUserId()

Gets the user id for this signer in external application responsible for authentication when accessing the embed url.

Returns:

embed url external user id.

getHasViewedEmail

public boolean getHasViewedEmail()

Gets the flag indicating if signer has viewed the sign request email.

Returns:

true if the signer has viewed the sign request email, otherwise false.

getHasViewedDocument

public boolean getHasViewedDocument()

Gets the flag indicating if signer has viewed the document.

Returns:

true if the signer has viewed the document, otherwise false.

getSignerDecision

public BoxSignRequestSigner.BoxSignerDecision getSignerDecision()

Gets the final decision made by signer.

Returns:

final decision made by signer.

getInputs

public List<BoxSignRequestSigner.BoxSignerInput> getInputs()

Gets the inputs created by a signer on a sign request.

Returns:

list of inputs created by a signer on a sign request.

getEmbedUrl

public String getEmbedUrl()

Gets the url to direct signer to for signing.

Returns:

url to direct signer to for signing.

setEmail

public BoxSignRequestSigner setEmail(String email)

Sets the email address of the signer.

Parameters:

email - address of the signer.

Returns:

this BoxSignRequestSigner object for chaining.

setRole

public BoxSignRequestSigner setRole(BoxSignRequestSignerRole role)

Sets the role of the signer. If role is not set it's FinalCopyReader by default.

Parameters:

role - of the signer.

Returns:

this BoxSignRequestSigner object for chaining.

getInPerson

public Boolean getInPerson()

Gets the flag that is used in combination with an embed url for a the sender. After the sender signs, they will be redirected to the next InPerson signer.

Returns:

true if is in person signer, otherwise false.

setInPerson

public BoxSignRequestSigner setInPerson(Boolean isInPerson)

Sets the flag that is used in combination with an embed url for a the sender. After the sender signs, they will be redirected to the next InPerson signer.

Parameters:

isInPerson - flag.

Returns:

this BoxSignRequestSigner object for chaining.

setOrder

public BoxSignRequestSigner setOrder(Integer order)

Sets the order of signer.

Parameters:

order - of signer.

Returns:

this BoxSignRequestSigner object for chaining.

setEmbedUrlExternalUserId

public BoxSignRequestSigner setEmbedUrlExternalUserId(String embedUrlExternalUserId)

Sets the user id for this signer in external application responsible for authentication when accessing the embed url.

Parameters:

embedUrlExternalUserId - for this signer in external application responsible for authentication when accessing the embed url.

Returns:

this BoxSignRequestSigner object for chaining.

getJSONObject

public JsonObject getJSONObject()

Gets a JSON object representing this class.

Returns:

the JSON object representing this class.