com.box.sdk

Class BoxSignRequestFile

Object

BoxSignRequestFile

public class BoxSignRequestFile
extends Object

Represents a Box File to be included in a sign request.

Constructor Summary

Constructors

Constructor and Description
BoxSignRequestFile(String fileId) Constructs a BoxSignRequestFile to be used during sign request creation.
BoxSignRequestFile(String fileId, String fileVersionId) Constructs a BoxSignRequestFile with specific file version to be used during sign request creation.

Method Summary

Modifier and Type	Method and Description
String	getFileId() Gets the file id of the file.
String	getFileVersionId() Gets the file version id of the file.
JsonObject	getJSONObject() Gets a JSON object representing this class.
BoxSignRequestFile	setFileId(String fileId) Sets the file id.
BoxSignRequestFile	setFileVersionId(String fileVersionId) Sets the file version id.

Methods inherited from class Object

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

Constructor Detail

BoxSignRequestFile

public BoxSignRequestFile(String fileId,
                          String fileVersionId)

Constructs a BoxSignRequestFile with specific file version to be used during sign request creation.

Parameters:

fileId - id of the file.

fileVersionId - id of the file versionm.

BoxSignRequestFile

public BoxSignRequestFile(String fileId)

Constructs a BoxSignRequestFile to be used during sign request creation.

Parameters:

fileId - id of the file.

Method Detail

getFileId

public String getFileId()

Gets the file id of the file.

Returns:

file id of the file.

setFileId

public BoxSignRequestFile setFileId(String fileId)

Sets the file id.

Parameters:

fileId - of the file.

Returns:

this BoxSignRequestFile object for chaining.

getFileVersionId

public String getFileVersionId()

Gets the file version id of the file.

Returns:

file version id of the file.

setFileVersionId

public BoxSignRequestFile setFileVersionId(String fileVersionId)

Sets the file version id.

Parameters:

fileVersionId - of the file.

Returns:

this BoxSignRequestFile object for chaining.

getJSONObject

public JsonObject getJSONObject()

Gets a JSON object representing this class.

Returns:

the JSON object representing this class.