com.box.sdkgen.managers.filerequests

Class FileRequestsManager

Object

FileRequestsManager

public class FileRequestsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileRequestsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileRequestsManager()
protected	FileRequestsManager(FileRequestsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
FileRequest	createFileRequestCopy(String fileRequestId, FileRequestCopyRequest requestBody) Copies an existing file request that is already present on one folder, and applies it to another folder.
FileRequest	createFileRequestCopy(String fileRequestId, FileRequestCopyRequest requestBody, CreateFileRequestCopyHeaders headers) Copies an existing file request that is already present on one folder, and applies it to another folder.
void	deleteFileRequestById(String fileRequestId) Deletes a file request permanently.
void	deleteFileRequestById(String fileRequestId, DeleteFileRequestByIdHeaders headers) Deletes a file request permanently.
Authentication	getAuth()
FileRequest	getFileRequestById(String fileRequestId) Retrieves the information about a file request.
FileRequest	getFileRequestById(String fileRequestId, GetFileRequestByIdHeaders headers) Retrieves the information about a file request.
NetworkSession	getNetworkSession()
FileRequest	updateFileRequestById(String fileRequestId, FileRequestUpdateRequest requestBody) Updates a file request.
FileRequest	updateFileRequestById(String fileRequestId, FileRequestUpdateRequest requestBody, UpdateFileRequestByIdHeaders headers) Updates a file request.

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

FileRequestsManager

public FileRequestsManager()

FileRequestsManager

protected FileRequestsManager(FileRequestsManager.Builder builder)

Method Detail

getFileRequestById

public FileRequest getFileRequestById(String fileRequestId)

Retrieves the information about a file request.

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

getFileRequestById

public FileRequest getFileRequestById(String fileRequestId,
                                      GetFileRequestByIdHeaders headers)

Retrieves the information about a file request.

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

headers - Headers of getFileRequestById method

updateFileRequestById

public FileRequest updateFileRequestById(String fileRequestId,
                                         FileRequestUpdateRequest requestBody)

Updates a file request. This can be used to activate or deactivate a file request.

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

requestBody - Request body of updateFileRequestById method

updateFileRequestById

public FileRequest updateFileRequestById(String fileRequestId,
                                         FileRequestUpdateRequest requestBody,
                                         UpdateFileRequestByIdHeaders headers)

Updates a file request. This can be used to activate or deactivate a file request.

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

requestBody - Request body of updateFileRequestById method

headers - Headers of updateFileRequestById method

deleteFileRequestById

public void deleteFileRequestById(String fileRequestId)

Deletes a file request permanently.

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

deleteFileRequestById

public void deleteFileRequestById(String fileRequestId,
                                  DeleteFileRequestByIdHeaders headers)

Deletes a file request permanently.

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

headers - Headers of deleteFileRequestById method

createFileRequestCopy

public FileRequest createFileRequestCopy(String fileRequestId,
                                         FileRequestCopyRequest requestBody)

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

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

requestBody - Request body of createFileRequestCopy method

createFileRequestCopy

public FileRequest createFileRequestCopy(String fileRequestId,
                                         FileRequestCopyRequest requestBody,
                                         CreateFileRequestCopyHeaders headers)

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

Parameters:

fileRequestId - The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/filerequest/123` the `file_request_id` is `123`. Example: "123"

requestBody - Request body of createFileRequestCopy method

headers - Headers of createFileRequestCopy method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()