com.box.sdkgen.managers.trashedfolders

Class TrashedFoldersManager

Object

TrashedFoldersManager

public class TrashedFoldersManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrashedFoldersManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deleteTrashedFolderById(String folderId) Permanently deletes a folder that is in the trash.
void	deleteTrashedFolderById(String folderId, DeleteTrashedFolderByIdHeaders headers) Permanently deletes a folder that is in the trash.
Authentication	getAuth()
NetworkSession	getNetworkSession()
TrashFolder	getTrashedFolderById(String folderId) Retrieves a folder that has been moved to the trash.
TrashFolder	getTrashedFolderById(String folderId, GetTrashedFolderByIdHeaders headers) Retrieves a folder that has been moved to the trash.
TrashFolder	getTrashedFolderById(String folderId, GetTrashedFolderByIdQueryParams queryParams) Retrieves a folder that has been moved to the trash.
TrashFolder	getTrashedFolderById(String folderId, GetTrashedFolderByIdQueryParams queryParams, GetTrashedFolderByIdHeaders headers) Retrieves a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashHeaders headers) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashQueryParams queryParams) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashQueryParams queryParams, RestoreFolderFromTrashHeaders headers) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashRequestBody requestBody) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashRequestBody requestBody, RestoreFolderFromTrashHeaders headers) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashRequestBody requestBody, RestoreFolderFromTrashQueryParams queryParams) Restores a folder that has been moved to the trash.
TrashFolderRestored	restoreFolderFromTrash(String folderId, RestoreFolderFromTrashRequestBody requestBody, RestoreFolderFromTrashQueryParams queryParams, RestoreFolderFromTrashHeaders headers) Restores a folder 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

TrashedFoldersManager

public TrashedFoldersManager()

TrashedFoldersManager

protected TrashedFoldersManager(TrashedFoldersManager.Builder builder)

Method Detail

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashRequestBody requestBody)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of restoreFolderFromTrash method

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashQueryParams queryParams)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

queryParams - Query parameters of restoreFolderFromTrash method

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashRequestBody requestBody,
                                                  RestoreFolderFromTrashQueryParams queryParams)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of restoreFolderFromTrash method

queryParams - Query parameters of restoreFolderFromTrash method

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashHeaders headers)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of restoreFolderFromTrash method

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashRequestBody requestBody,
                                                  RestoreFolderFromTrashHeaders headers)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of restoreFolderFromTrash method

headers - Headers of restoreFolderFromTrash method

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashQueryParams queryParams,
                                                  RestoreFolderFromTrashHeaders headers)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

queryParams - Query parameters of restoreFolderFromTrash method

headers - Headers of restoreFolderFromTrash method

restoreFolderFromTrash

public TrashFolderRestored restoreFolderFromTrash(String folderId,
                                                  RestoreFolderFromTrashRequestBody requestBody,
                                                  RestoreFolderFromTrashQueryParams queryParams,
                                                  RestoreFolderFromTrashHeaders headers)

Restores a folder that has been moved to the trash.

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

During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.

For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

requestBody - Request body of restoreFolderFromTrash method

queryParams - Query parameters of restoreFolderFromTrash method

headers - Headers of restoreFolderFromTrash method

getTrashedFolderById

public TrashFolder getTrashedFolderById(String folderId)

Retrieves a folder that has been moved to the trash.

Please note that only if the folder 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:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

getTrashedFolderById

public TrashFolder getTrashedFolderById(String folderId,
                                        GetTrashedFolderByIdQueryParams queryParams)

Retrieves a folder that has been moved to the trash.

Please note that only if the folder 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:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

queryParams - Query parameters of getTrashedFolderById method

getTrashedFolderById

public TrashFolder getTrashedFolderById(String folderId,
                                        GetTrashedFolderByIdHeaders headers)

Retrieves a folder that has been moved to the trash.

Please note that only if the folder 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:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of getTrashedFolderById method

getTrashedFolderById

public TrashFolder getTrashedFolderById(String folderId,
                                        GetTrashedFolderByIdQueryParams queryParams,
                                        GetTrashedFolderByIdHeaders headers)

Retrieves a folder that has been moved to the trash.

Please note that only if the folder 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:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

queryParams - Query parameters of getTrashedFolderById method

headers - Headers of getTrashedFolderById method

deleteTrashedFolderById

public void deleteTrashedFolderById(String folderId)

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

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

deleteTrashedFolderById

public void deleteTrashedFolderById(String folderId,
                                    DeleteTrashedFolderByIdHeaders headers)

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

Parameters:

folderId - The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`.

The root folder of a Box account is always represented by the ID `0`. Example: "12345"

headers - Headers of deleteTrashedFolderById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()