com.box.sdk

Class BoxSignRequest

Object

BoxResource

BoxSignRequest

@BoxResourceType(value="sign_request")
public class BoxSignRequest
extends BoxResource

Represents a Sign Request used by Box Sign. Sign Requests are used to request e-signatures on documents from signers. A Sign Request can refer to one or more Box Files and can be sent to one or more Box Sign Request Signers.

See Also:

Box Sign Request

Unless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxSignRequest.BoxSignRequestStatus Represents a status of the sign request.
class	BoxSignRequest.Info Contains information about the Sign Request.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	SIGN_REQUEST_CANCEL_URL_TEMPLATE The URL template used to cancel an existing Sign Request.
static URLTemplate	SIGN_REQUEST_RESEND_URL_TEMPLATE The URL template used to resend an existing Sign Request.
static URLTemplate	SIGN_REQUEST_URL_TEMPLATE The URL template used for Sign Request operations with a given ID.
static URLTemplate	SIGN_REQUESTS_URL_TEMPLATE The URL template used for operation Sign Request operations.

Constructor Summary

Constructors

Constructor and Description
BoxSignRequest(BoxAPIConnection api, String id) Constructs a BoxResource for a resource with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxSignRequest.Info	cancel() Cancels a sign request if it has not yet been signed or declined.
static BoxSignRequest.Info	createSignRequest(BoxAPIConnection api, List<BoxSignRequestFile> sourceFiles, List<BoxSignRequestSigner> signers, String parentFolderId) Used to create a new sign request.
static BoxSignRequest.Info	createSignRequest(BoxAPIConnection api, List<BoxSignRequestFile> sourceFiles, List<BoxSignRequestSigner> signers, String parentFolderId, BoxSignRequestCreateParams optionalParams) Used to create a new sign request with optional parameters.
static BoxSignRequest.Info	createSignRequestFromFiles(BoxAPIConnection api, List<BoxFile.Info> sourceFiles, List<BoxSignRequestSigner> signers, String parentFolderId) Used to create a new sign request using BoxFile.Info models.
static BoxSignRequest.Info	createSignRequestFromFiles(BoxAPIConnection api, List<BoxFile.Info> sourceFiles, List<BoxSignRequestSigner> signers, String parentFolderId, BoxSignRequestCreateParams optionalParams) Used to create a new sign request using existing BoxFile.Info models.
static Iterable<BoxSignRequest.Info>	getAll(BoxAPIConnection api, int limit, String... fields) Returns all the sign requests.
static Iterable<BoxSignRequest.Info>	getAll(BoxAPIConnection api, String... fields) Returns all the sign requests.
BoxSignRequest.Info	getInfo(String... fields) Returns information about this sign request.
void	resend() Attempts to resend a Sign Request to all signers that have not signed yet.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

SIGN_REQUESTS_URL_TEMPLATE

public static final URLTemplate SIGN_REQUESTS_URL_TEMPLATE

The URL template used for operation Sign Request operations.

SIGN_REQUEST_URL_TEMPLATE

public static final URLTemplate SIGN_REQUEST_URL_TEMPLATE

The URL template used for Sign Request operations with a given ID.

SIGN_REQUEST_CANCEL_URL_TEMPLATE

public static final URLTemplate SIGN_REQUEST_CANCEL_URL_TEMPLATE

The URL template used to cancel an existing Sign Request.

SIGN_REQUEST_RESEND_URL_TEMPLATE

public static final URLTemplate SIGN_REQUEST_RESEND_URL_TEMPLATE

The URL template used to resend an existing Sign Request.

Constructor Detail

BoxSignRequest

public BoxSignRequest(BoxAPIConnection api,
                      String id)

Constructs a BoxResource for a resource with a given ID.

Parameters:

api - the API connection to be used by the resource.

id - the ID of the resource.

Method Detail

createSignRequestFromFiles

public static BoxSignRequest.Info createSignRequestFromFiles(BoxAPIConnection api,
                                                             List<BoxFile.Info> sourceFiles,
                                                             List<BoxSignRequestSigner> signers,
                                                             String parentFolderId,
                                                             BoxSignRequestCreateParams optionalParams)

Used to create a new sign request using existing BoxFile.Info models.

Parameters:

api - the API connection to be used by the created user.

sourceFiles - the list of BoxFile.Info files to create a signing document from.

signers - the list of signers for this sign request.

parentFolderId - the id of the destination folder to place sign request specific data in.

optionalParams - the optional parameters.

Returns:

the created sign request's info.

createSignRequestFromFiles

public static BoxSignRequest.Info createSignRequestFromFiles(BoxAPIConnection api,
                                                             List<BoxFile.Info> sourceFiles,
                                                             List<BoxSignRequestSigner> signers,
                                                             String parentFolderId)

Used to create a new sign request using BoxFile.Info models.

Parameters:

api - the API connection to be used by the created user.

sourceFiles - the list of BoxFile.Info files to create a signing document from.

signers - the list of signers for this sign request.

parentFolderId - the id of the destination folder to place sign request specific data in.

Returns:

the created sign request's info.

createSignRequest

public static BoxSignRequest.Info createSignRequest(BoxAPIConnection api,
                                                    List<BoxSignRequestFile> sourceFiles,
                                                    List<BoxSignRequestSigner> signers,
                                                    String parentFolderId)

Used to create a new sign request.

Parameters:

api - the API connection to be used by the created user.

sourceFiles - the list of files to a signing document from.

signers - the list of signers for this sign request.

parentFolderId - the id of the destination folder to place sign request specific data in.

Returns:

the created sign request's info.

createSignRequest

public static BoxSignRequest.Info createSignRequest(BoxAPIConnection api,
                                                    List<BoxSignRequestFile> sourceFiles,
                                                    List<BoxSignRequestSigner> signers,
                                                    String parentFolderId,
                                                    BoxSignRequestCreateParams optionalParams)

Used to create a new sign request with optional parameters.

Parameters:

api - the API connection to be used by the created user.

signers - the list of signers for this sign request.

sourceFiles - the list of files to a signing document from.

parentFolderId - the id of the destination folder to place sign request specific data in.

optionalParams - the optional parameters.

Returns:

the created sign request's info.

getAll

public static Iterable<BoxSignRequest.Info> getAll(BoxAPIConnection api,
                                                   String... fields)

Returns all the sign requests.

Parameters:

api - the API connection to be used by the resource.

fields - the fields to retrieve.

Returns:

an iterable with all the sign requests.

getAll

public static Iterable<BoxSignRequest.Info> getAll(BoxAPIConnection api,
                                                   int limit,
                                                   String... fields)

Returns all the sign requests.

Parameters:

api - the API connection to be used by the resource.

limit - the limit of items per single response. The default value is 100.

fields - the fields to retrieve.

Returns:

an iterable with all the sign requests.

getInfo

public BoxSignRequest.Info getInfo(String... fields)

Returns information about this sign request.

Parameters:

fields - the fields to retrieve.

Returns:

information about this sign request.

cancel

public BoxSignRequest.Info cancel()

Cancels a sign request if it has not yet been signed or declined. Any outstanding signers will no longer be able to sign the document.

Returns:

the cancelled sign request's info.

resend

public void resend()

Attempts to resend a Sign Request to all signers that have not signed yet. There is a 10 minute cooling-off period between each resend request. If you make a resend call during the cooling-off period, a BoxAPIException will be thrown.