com.box.sdk

Class BoxFileRequest

Object

BoxResource

BoxFileRequest

@BoxResourceType(value="file_request")
public class BoxFileRequest
extends BoxResource

Represents a file request on Box.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxFileRequest.Info Contains information about a BoxFileRequest.
static class	BoxFileRequest.Status The status of the file request.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	COPY_FILE_REQUEST_URL_TEMPLATE Copy File Request URL Template.
static URLTemplate	FILE_REQUEST_URL_TEMPLATE File Request URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxFileRequest(BoxAPIConnection api, String id) Constructs a BoxFileRequest for a file request with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxFileRequest.Info	copyInfo(BoxFileRequest.Info info, String folderId) Copies this file request that is already present on one folder, and applies it to another folder.
BoxFileRequest.Info	copyInfo(String folderId) Copies this file request that is already present on one folder, and applies it to another folder.
void	delete() Delete this file request.
BoxFileRequest.Info	getInfo() Gets information about this file request.
BoxFileRequest.Info	updateInfo(BoxFileRequest.Info info) Updates the information about this file request with any info fields that have been modified locally.

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

FILE_REQUEST_URL_TEMPLATE

public static final URLTemplate FILE_REQUEST_URL_TEMPLATE

File Request URL Template.

COPY_FILE_REQUEST_URL_TEMPLATE

public static final URLTemplate COPY_FILE_REQUEST_URL_TEMPLATE

Copy File Request URL Template.

Constructor Detail

BoxFileRequest

public BoxFileRequest(BoxAPIConnection api,
                      String id)

Constructs a BoxFileRequest for a file request with a given ID.

Parameters:

api - the API connection to be used by the file request.

id - the ID of the file request.

Method Detail

getInfo

public BoxFileRequest.Info getInfo()

Gets information about this file request.

Returns:

info about this file request.

copyInfo

public BoxFileRequest.Info copyInfo(String folderId)

Copies this file request that is already present on one folder, and applies it to another folder.

Parameters:

folderId - the ID of the folder for the file request.

Returns:

info about the newly copied file request.

copyInfo

public BoxFileRequest.Info copyInfo(BoxFileRequest.Info info,
                                    String folderId)

Copies this file request that is already present on one folder, and applies it to another folder.

Info fields that have been modified locally will overwrite the values in the original file request.

Parameters:

info - the info.

folderId - the ID of the folder for the file request.

Returns:

info about the newly copied file request.

updateInfo

public BoxFileRequest.Info updateInfo(BoxFileRequest.Info info)

Updates the information about this file request with any info fields that have been modified locally.

The only fields that will be updated are the ones that have been modified locally. For example, the following code won't update any information (or even send a network request) since none of the info's fields were changed:

BoxFileRequest fileRequest = new BoxFileRequest(api, id);
 BoxFileRequest.Info info = fileRequest.getInfo();
 info.updateInfo(info);

Parameters:

info - the updated info.

Returns:

info about the updated file request.

delete

public void delete()

Delete this file request.