box-node-sdk

TrashedFoldersManager

• Restore folder
• Get trashed folder
• Permanently remove folder

Restore folder

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.

This operation is performed by calling function restoreFolderFromTrash.

See the endpoint docs at API Reference.

await client.trashedFolders.restoreFolderFromTrash(folder.id);

Arguments

• folderId string
  • 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”
• optionalsInput RestoreFolderFromTrashOptionalsInput

Returns

This function returns a value of type TrashFolderRestored.

Returns a folder object when the folder has been restored.

Get trashed folder

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 API.

To list all items that have been moved to the trash, please use the GET /folders/trash/items API.

This operation is performed by calling function getTrashedFolderById.

See the endpoint docs at API Reference.

await client.trashedFolders.getTrashedFolderById(folder.id);

Arguments

• folderId string
  • 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”
• optionalsInput GetTrashedFolderByIdOptionalsInput

Returns

This function returns a value of type TrashFolder.

Returns the folder that was trashed, including information about when the it was moved to the trash.

Permanently remove folder

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

This operation is performed by calling function deleteTrashedFolderById.

See the endpoint docs at API Reference.

await client.trashedFolders.deleteTrashedFolderById(folder.id);

Arguments

• folderId string
  • 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”
• optionalsInput DeleteTrashedFolderByIdOptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the folder was permanently deleted.

This site is open source. Improve this page.