com.box.sdkgen.managers.trashedfiles

Class TrashedFilesManager

Object

TrashedFilesManager

public class TrashedFilesManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrashedFilesManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteTrashedFileById(String fileId) Permanently deletes a file that is in the trash.
void	deleteTrashedFileById(String fileId, DeleteTrashedFileByIdHeaders headers) Permanently deletes a file that is in the trash.
Authentication	getAuth()
NetworkSession	getNetworkSession()
TrashFile	getTrashedFileById(String fileId) Retrieves a file that has been moved to the trash.
TrashFile	getTrashedFileById(String fileId, GetTrashedFileByIdHeaders headers) Retrieves a file that has been moved to the trash.
TrashFile	getTrashedFileById(String fileId, GetTrashedFileByIdQueryParams queryParams) Retrieves a file that has been moved to the trash.
TrashFile	getTrashedFileById(String fileId, GetTrashedFileByIdQueryParams queryParams, GetTrashedFileByIdHeaders headers) Retrieves a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashHeaders headers) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashQueryParams queryParams) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashQueryParams queryParams, RestoreFileFromTrashHeaders headers) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashRequestBody requestBody) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashRequestBody requestBody, RestoreFileFromTrashHeaders headers) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashRequestBody requestBody, RestoreFileFromTrashQueryParams queryParams) Restores a file that has been moved to the trash.
TrashFileRestored	restoreFileFromTrash(String fileId, RestoreFileFromTrashRequestBody requestBody, RestoreFileFromTrashQueryParams queryParams, RestoreFileFromTrashHeaders headers) Restores a file that has been moved to the trash.

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

TrashedFilesManager

public TrashedFilesManager()

TrashedFilesManager

protected TrashedFilesManager(TrashedFilesManager.Builder builder)

Method Detail

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashRequestBody requestBody)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

requestBody - Request body of restoreFileFromTrash method

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashQueryParams queryParams)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

queryParams - Query parameters of restoreFileFromTrash method

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashRequestBody requestBody,
                                              RestoreFileFromTrashQueryParams queryParams)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

requestBody - Request body of restoreFileFromTrash method

queryParams - Query parameters of restoreFileFromTrash method

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashHeaders headers)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

headers - Headers of restoreFileFromTrash method

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashRequestBody requestBody,
                                              RestoreFileFromTrashHeaders headers)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

requestBody - Request body of restoreFileFromTrash method

headers - Headers of restoreFileFromTrash method

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashQueryParams queryParams,
                                              RestoreFileFromTrashHeaders headers)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

queryParams - Query parameters of restoreFileFromTrash method

headers - Headers of restoreFileFromTrash method

restoreFileFromTrash

public TrashFileRestored restoreFileFromTrash(String fileId,
                                              RestoreFileFromTrashRequestBody requestBody,
                                              RestoreFileFromTrashQueryParams queryParams,
                                              RestoreFileFromTrashHeaders headers)

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Parameters:

fileId - The unique identifier that represents a file.

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

requestBody - Request body of restoreFileFromTrash method

queryParams - Query parameters of restoreFileFromTrash method

headers - Headers of restoreFileFromTrash method

getTrashedFileById

public TrashFile getTrashedFileById(String fileId)

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.

To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/) API.

Parameters:

fileId - The unique identifier that represents a file.

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

getTrashedFileById

public TrashFile getTrashedFileById(String fileId,
                                    GetTrashedFileByIdQueryParams queryParams)

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.

To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/) API.

Parameters:

fileId - The unique identifier that represents a file.

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

queryParams - Query parameters of getTrashedFileById method

getTrashedFileById

public TrashFile getTrashedFileById(String fileId,
                                    GetTrashedFileByIdHeaders headers)

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.

To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/) API.

Parameters:

fileId - The unique identifier that represents a file.

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

headers - Headers of getTrashedFileById method

getTrashedFileById

public TrashFile getTrashedFileById(String fileId,
                                    GetTrashedFileByIdQueryParams queryParams,
                                    GetTrashedFileByIdHeaders headers)

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.

To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/) API.

Parameters:

fileId - The unique identifier that represents a file.

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

queryParams - Query parameters of getTrashedFileById method

headers - Headers of getTrashedFileById method

deleteTrashedFileById

public void deleteTrashedFileById(String fileId)

Permanently deletes a file that is in the trash. This action cannot be undone.

Parameters:

fileId - The unique identifier that represents a file.

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

deleteTrashedFileById

public void deleteTrashedFileById(String fileId,
                                  DeleteTrashedFileByIdHeaders headers)

Permanently deletes a file that is in the trash. This action cannot be undone.

Parameters:

fileId - The unique identifier that represents a file.

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

headers - Headers of deleteTrashedFileById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()