com.box.sdk

Class BoxSignTemplateSigner

Object

BoxJSONObject

BoxSignTemplateSigner

public class BoxSignTemplateSigner
extends BoxJSONObject

Box Sign Template signer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxSignTemplateSigner.BoxSignTemplateSignerInput Box Sign Template signer input.
static class	BoxSignTemplateSigner.BoxSignTemplateSignerInputContentType Box Sign Template signer input content type.
class	BoxSignTemplateSigner.BoxSignTemplateSignerInputCoordinates Box Sign Template signer input coordinates.
static class	BoxSignTemplateSigner.BoxSignTemplateSignerInputType Box Sign Template signer input type.
class	BoxSignTemplateSigner.BoxSignTemplatesSignerInputDimensions Box Sign Template signer input dimensions.

Constructor Summary

Constructors

Constructor and Description
BoxSignTemplateSigner(JsonObject jsonObject, BoxAPIConnection api) Constructs a BoxSignTemplateSigner object with the provided JSON object.
BoxSignTemplateSigner(String email, List<BoxSignTemplateSigner.BoxSignTemplateSignerInput> inputs, Boolean isInPerson, int order, BoxSignRequestSignerRole role) Constructs a BoxSignTemplateSigner object with the provided information.
BoxSignTemplateSigner(String email, List<BoxSignTemplateSigner.BoxSignTemplateSignerInput> inputs, Boolean isInPerson, int order, BoxSignRequestSignerRole role, String signerGroupId) Constructs a BoxSignTemplateSigner object with the provided information.

Method Summary

Modifier and Type	Method and Description
String	getEmail() Gets the email of the signer.
List<BoxSignTemplateSigner.BoxSignTemplateSignerInput>	getInputs() Gets the inputs of the signer.
Boolean	getIsInPerson() Used in combination with an embed URL for a sender.
int	getOrder() Gets the order of the signer.
BoxSignRequestSignerRole	getRole() Gets the role of the signer.
String	getSignerGroupId() Gets the signer group id.

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

BoxSignTemplateSigner

public BoxSignTemplateSigner(String email,
                             List<BoxSignTemplateSigner.BoxSignTemplateSignerInput> inputs,
                             Boolean isInPerson,
                             int order,
                             BoxSignRequestSignerRole role)

Constructs a BoxSignTemplateSigner object with the provided information.

Parameters:

email - the email.

inputs - the inputs.

isInPerson - whether the signer is in person or not.

order - the order.

role - the role.

BoxSignTemplateSigner

public BoxSignTemplateSigner(String email,
                             List<BoxSignTemplateSigner.BoxSignTemplateSignerInput> inputs,
                             Boolean isInPerson,
                             int order,
                             BoxSignRequestSignerRole role,
                             String signerGroupId)

Constructs a BoxSignTemplateSigner object with the provided information.

Parameters:

email - the email.

inputs - the inputs.

isInPerson - whether the signer is in person or not.

order - the order.

role - the role.

signerGroupId - the signer group id.

BoxSignTemplateSigner

public BoxSignTemplateSigner(JsonObject jsonObject,
                             BoxAPIConnection api)

Constructs a BoxSignTemplateSigner object with the provided JSON object.

Parameters:

jsonObject - the JSON object representing the Sign Template Signer.

Method Detail

getEmail

public String getEmail()

Gets the email of the signer.

Returns:

the email of the signer.

getInputs

public List<BoxSignTemplateSigner.BoxSignTemplateSignerInput> getInputs()

Gets the inputs of the signer.

Returns:

the inputs of the signer.

getIsInPerson

public Boolean getIsInPerson()

Used in combination with an embed URL for a sender. After the sender signs, they will be redirected to the next in_person signer.

Returns:

true if the signer is in person; otherwise false.

getOrder

public int getOrder()

Gets the order of the signer.

Returns:

the order of the signer.

getRole

public BoxSignRequestSignerRole getRole()

Gets the role of the signer.

Returns:

the role of the signer.

getSignerGroupId

public String getSignerGroupId()

Gets the signer group id. It is sufficient for only one signer from the group to sign the document.

Returns:

the id of the group signer.