box-node-sdk

TrashedFilesManager

• Restore file
• Get trashed file
• Permanently remove file

Restore file

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.

This operation is performed by calling function restoreFileFromTrash.

See the endpoint docs at API Reference.

await client.trashedFiles.restoreFileFromTrash(file.id);

Arguments

• fileId string
  • 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”
• optionalsInput RestoreFileFromTrashOptionalsInput

Returns

This function returns a value of type TrashFileRestored.

Returns a file object when the file has been restored.

Get trashed file

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

See the endpoint docs at API Reference.

await client.trashedFiles.getTrashedFileById(file.id);

Arguments

• fileId string
  • 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”
• optionalsInput GetTrashedFileByIdOptionalsInput

Returns

This function returns a value of type TrashFile.

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

Permanently remove file

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

This operation is performed by calling function deleteTrashedFileById.

See the endpoint docs at API Reference.

await client.trashedFiles.deleteTrashedFileById(file.id);

Arguments

• fileId string
  • 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”
• optionalsInput DeleteTrashedFileByIdOptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the file was permanently deleted.

This site is open source. Improve this page.