BoxSignRequestSigner (Box Java SDK)

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.BoxSignRequestInputContentType` Represents a content type of input.
`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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDeclinedRedirectUrl()` Gets the declined redirect url for the signer.
`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.
`String`	`getIframeableEmedUrl()` Gets the URL designed for signing documents within an HTML iframe tag.
`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.
`String`	`getRedirectUrl()` Gets the redirect url for the signer.
`BoxSignRequestSignerRole`	`getRole()` Gets the role of the signer.
`BoxSignRequestSigner.BoxSignerDecision`	`getSignerDecision()` Gets the final decision made by signer.
`String`	`getSignerGroupId()` Gets the signer group id.
`BoxSignRequestSigner`	`setDeclinedRedirectUrl(String declinedRedirectUrl)` Sets the declined redirect url for the 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`	`setIframeableEmedUrl(String iframeableEmedUrl)` Sets the URL designed for signing documents within an HTML iframe tag.
`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`	`setRedirectUrl(String redirectUrl)` Sets the redirect url for the signer.
`BoxSignRequestSigner`	`setRole(BoxSignRequestSignerRole role)` Sets the role of the signer.
`BoxSignRequestSigner`	`setSignerGroupId(String signerGroupId)` Sets the group id.

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.
  - 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.
  - getRole
```
public BoxSignRequestSignerRole getRole()
```
    Gets the role of the signer.
    
    Returns:
    
    role of the signer.
  - 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.
  - 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.
  - setOrder
```
public BoxSignRequestSigner setOrder(Integer order)
```
    Sets the order of signer.
    
    Parameters:
    
    order - of signer.
    
    Returns:
    
    this BoxSignRequestSigner object for chaining.
  - 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.
  - 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.
  - 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.
  - 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.
  - getRedirectUrl
```
public String getRedirectUrl()
```
    Gets the redirect url for the signer.
    
    Returns:
    
    redirect url for the signer.
  - setRedirectUrl
```
public BoxSignRequestSigner setRedirectUrl(String redirectUrl)
```
    Sets the redirect url for the signer.
    
    Parameters:
    
    redirectUrl - for the signer.
    
    Returns:
    
    this BoxSignRequestSigner object for chaining.
  - getDeclinedRedirectUrl
```
public String getDeclinedRedirectUrl()
```
    Gets the declined redirect url for the signer.
    
    Returns:
    
    declined redirect url for the signer.
  - setDeclinedRedirectUrl
```
public BoxSignRequestSigner setDeclinedRedirectUrl(String declinedRedirectUrl)
```
    Sets the declined redirect url for the signer.
    
    Parameters:
    
    declinedRedirectUrl - for the signer.
    
    Returns:
    
    this BoxSignRequestSigner object for chaining.
  - getIframeableEmedUrl
```
public String getIframeableEmedUrl()
```
    Gets the URL designed for signing documents within an HTML iframe tag. It will be returned in the response only if the embedUrlExternalUserId parameter was passed in the create sign request call.
    
    Returns:
    
    url for signing documents within an HTML iframe tag.
  - setIframeableEmedUrl
```
public BoxSignRequestSigner setIframeableEmedUrl(String iframeableEmedUrl)
```
    Sets the URL designed for signing documents within an HTML iframe tag. It will be returned in the response only if the embedUrlExternalUserId parameter was passed in the create sign request call.
    
    Parameters:
    
    iframeableEmedUrl - url for signing documents within an HTML iframe tag.
    
    Returns:
    
    this BoxSignRequestSigner object for chaining.
  - getSignerGroupId
```
public String getSignerGroupId()
```
    Gets the signer group id. It is sufficient for only one signer from the group to sign the document.
    
    Returns:
    
    id of the group to which the sign request will be sent.
  - setSignerGroupId
```
public BoxSignRequestSigner setSignerGroupId(String signerGroupId)
```
    Sets the group id. If specified, signers sharing the same group ID will be assigned to the same input. The group ID can be any string value, but it must be consistent across all signers. It is sufficient for only one signer from the group to sign the document.
    
    Parameters:
    
    signerGroupId - id of the group to which the sign request will be sent
    
    Returns:
    
    this BoxSignRequestSigner object for chaining.
  - getJSONObject
```
public JsonObject getJSONObject()
```
    Gets a JSON object representing this class.
    
    Returns:
    
    the JSON object representing this class.

Class BoxSignRequestSigner

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class BoxJSONObject

Methods inherited from class Object

Constructor Detail

BoxSignRequestSigner

BoxSignRequestSigner

Method Detail

getEmail

setEmail

getRole

setRole

getIsInPerson

getOrder

setOrder

getEmbedUrlExternalUserId

setEmbedUrlExternalUserId

getHasViewedEmail

getHasViewedDocument

getSignerDecision

getInputs

getEmbedUrl

getInPerson

setInPerson

getRedirectUrl

setRedirectUrl

getDeclinedRedirectUrl

setDeclinedRedirectUrl

getIframeableEmedUrl

setIframeableEmedUrl

getSignerGroupId

setSignerGroupId

getJSONObject