com.box.sdk

Class BoxTrash

Object

BoxTrash

All Implemented Interfaces:

Iterable<BoxItem.Info>

public class BoxTrash
extends Object
implements Iterable<BoxItem.Info>

Provides methods for deleting, recovering, and viewing a user's trashed files and folders.

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	FILE_INFO_URL_TEMPLATE File Info URL Template.
static URLTemplate	FOLDER_INFO_URL_TEMPLATE Folder Info URL Template.
static URLTemplate	GET_ITEMS_URL Get Item URL Template.
static URLTemplate	RESTORE_FILE_URL_TEMPLATE Restore File URL Template.
static URLTemplate	RESTORE_FOLDER_URL_TEMPLATE Restore Folder URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxTrash(BoxAPIConnection api) Constructs a BoxTrash using a given API connection.

Method Summary

Modifier and Type	Method and Description
void	deleteFile(String fileID) Permanently deletes a trashed file.
void	deleteFolder(String folderID) Permanently deletes a trashed folder.
BoxFile.Info	getFileInfo(String fileID) Gets information about a trashed file.
BoxFile.Info	getFileInfo(String fileID, String... fields) Gets information about a trashed file that's limited to a list of specified fields.
BoxFolder.Info	getFolderInfo(String folderID) Gets information about a trashed folder.
BoxFolder.Info	getFolderInfo(String folderID, String... fields) Gets information about a trashed folder that's limited to a list of specified fields.
Iterable<BoxItem.Info>	items(SortParameters sortParameters, PagingParameters pagingParameters, String... fields) Returns an iterable containing the items in trash.
Iterator<BoxItem.Info>	iterator() Returns an iterator over the items in the trash.
BoxFile.Info	restoreFile(String fileID) Restores a trashed file back to its original location.
BoxFile.Info	restoreFile(String fileID, String newName, String newParentID) Restores a trashed file to a new location with a new name.
BoxFolder.Info	restoreFolder(String folderID) Restores a trashed folder back to its original location.
BoxFolder.Info	restoreFolder(String folderID, String newName, String newParentID) Restores a trashed folder to a new location with a new name.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Detail

GET_ITEMS_URL

public static final URLTemplate GET_ITEMS_URL

Get Item URL Template.

FOLDER_INFO_URL_TEMPLATE

public static final URLTemplate FOLDER_INFO_URL_TEMPLATE

Folder Info URL Template.

FILE_INFO_URL_TEMPLATE

public static final URLTemplate FILE_INFO_URL_TEMPLATE

File Info URL Template.

RESTORE_FILE_URL_TEMPLATE

public static final URLTemplate RESTORE_FILE_URL_TEMPLATE

Restore File URL Template.

RESTORE_FOLDER_URL_TEMPLATE

public static final URLTemplate RESTORE_FOLDER_URL_TEMPLATE

Restore Folder URL Template.

Constructor Detail

BoxTrash

public BoxTrash(BoxAPIConnection api)

Constructs a BoxTrash using a given API connection.

Parameters:

api - the API connection to be used by the trash.

Method Detail

deleteFolder

public void deleteFolder(String folderID)

Permanently deletes a trashed folder.

Parameters:

folderID - the ID of the trashed folder to permanently delete.

getFolderInfo

public BoxFolder.Info getFolderInfo(String folderID)

Gets information about a trashed folder.

Parameters:

folderID - the ID of the trashed folder.

Returns:

info about the trashed folder.

getFolderInfo

public BoxFolder.Info getFolderInfo(String folderID,
                                    String... fields)

Gets information about a trashed folder that's limited to a list of specified fields.

Parameters:

folderID - the ID of the trashed folder.

fields - the fields to retrieve.

Returns:

info about the trashed folder containing only the specified fields.

restoreFolder

public BoxFolder.Info restoreFolder(String folderID)

Restores a trashed folder back to its original location.

Parameters:

folderID - the ID of the trashed folder.

Returns:

info about the restored folder.

restoreFolder

public BoxFolder.Info restoreFolder(String folderID,
                                    String newName,
                                    String newParentID)

Restores a trashed folder to a new location with a new name.

Parameters:

folderID - the ID of the trashed folder.

newName - an optional new name to give the folder. This can be null to use the folder's original name.

newParentID - an optional new parent ID for the folder. This can be null to use the folder's original parent.

Returns:

info about the restored folder.

deleteFile

public void deleteFile(String fileID)

Permanently deletes a trashed file.

Parameters:

fileID - the ID of the trashed folder to permanently delete.

getFileInfo

public BoxFile.Info getFileInfo(String fileID)

Gets information about a trashed file.

Parameters:

fileID - the ID of the trashed file.

Returns:

info about the trashed file.

getFileInfo

public BoxFile.Info getFileInfo(String fileID,
                                String... fields)

Gets information about a trashed file that's limited to a list of specified fields.

Parameters:

fileID - the ID of the trashed file.

fields - the fields to retrieve.

Returns:

info about the trashed file containing only the specified fields.

restoreFile

public BoxFile.Info restoreFile(String fileID)

Restores a trashed file back to its original location.

Parameters:

fileID - the ID of the trashed file.

Returns:

info about the restored file.

restoreFile

public BoxFile.Info restoreFile(String fileID,
                                String newName,
                                String newParentID)

Restores a trashed file to a new location with a new name.

Parameters:

fileID - the ID of the trashed file.

newName - an optional new name to give the file. This can be null to use the file's original name.

newParentID - an optional new parent ID for the file. This can be null to use the file's original parent.

Returns:

info about the restored file.

iterator

public Iterator<BoxItem.Info> iterator()

Returns an iterator over the items in the trash.

Specified by:

iterator in interface Iterable<BoxItem.Info>

Returns:

an iterator over the items in the trash.

items

public Iterable<BoxItem.Info> items(SortParameters sortParameters,
                                    PagingParameters pagingParameters,
                                    String... fields)

Returns an iterable containing the items in trash. You can specify sort order, limit of files requested, ofset or use marker based pagination.

Parameters:

sortParameters - describes sorting parameters. Sort parameters are supported only with offset based pagination. Use SortParameters.none() to ignore sorting.

pagingParameters - describes paging parameters

fields - the fields to retrieve.

Returns:

an iterable containing the items in the trash.