com.box.sdk

Class BoxItem

Object

BoxResource

BoxItem

Direct Known Subclasses:

BoxFile, BoxFolder, BoxWebLink

public abstract class BoxItem
extends BoxResource

The abstract base class for items in a user's file tree (files, folders, etc.).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxItem.Info Contains information about a BoxItem.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_FIELDS An array of all possible file fields that can be requested when calling getInfo().
static URLTemplate	SHARED_ITEM_URL_TEMPLATE Shared Item URL Template.
static URLTemplate	WATERMARK_URL_TEMPLATE Url template for operations with watermarks.

Constructor Summary

Constructors

Constructor and Description
BoxItem(BoxAPIConnection api, String id) Constructs a BoxItem for an item with a given ID.

Method Summary

Modifier and Type	Method and Description
protected BoxWatermark	applyWatermark(URLTemplate itemUrl, String imprint) Used to apply or update the watermark for the item.
abstract BoxItem.Info	copy(BoxFolder destination) Copies this item to another folder.
abstract BoxItem.Info	copy(BoxFolder destination, String newName) Copies this item to another folder and gives it a new name.
abstract BoxSharedLink	createSharedLink(BoxSharedLink.Access access, Date unshareDate, BoxSharedLink.Permissions permissions) Creates a new shared link for this item.
abstract BoxItem.Info	getInfo() Gets information about this item.
abstract BoxItem.Info	getInfo(String... fields) Gets information about this item that's limited to a list of specified fields.
protected URL	getItemURL()
static BoxItem.Info	getSharedItem(BoxAPIConnection api, String sharedLink) Gets an item that was shared with a shared link.
static BoxItem.Info	getSharedItem(BoxAPIConnection api, String sharedLink, String password) Gets an item that was shared with a password-protected shared link.
protected BoxWatermark	getWatermark(URLTemplate itemUrl, String... fields) Used to retrieve the watermark for the item.
abstract BoxItem.Info	move(BoxFolder destination) Moves this item to another folder.
abstract BoxItem.Info	move(BoxFolder destination, String newName) Moves this item to another folder and gives it a new name.
protected void	removeWatermark(URLTemplate itemUrl) Removes a watermark from the item.
abstract BoxItem.Info	setCollections(BoxCollection... collections) Sets the collections that this item belongs to.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

ALL_FIELDS

public static final String[] ALL_FIELDS

An array of all possible file fields that can be requested when calling getInfo().

SHARED_ITEM_URL_TEMPLATE

public static final URLTemplate SHARED_ITEM_URL_TEMPLATE

Shared Item URL Template.

WATERMARK_URL_TEMPLATE

public static final URLTemplate WATERMARK_URL_TEMPLATE

Url template for operations with watermarks.

Constructor Detail

BoxItem

public BoxItem(BoxAPIConnection api,
               String id)

Constructs a BoxItem for an item with a given ID.

Parameters:

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

id - the ID of the item.

Method Detail

getItemURL

protected URL getItemURL()

Returns:

URL for the current object, constructed as base URL pus an item specifier.

getSharedItem

public static BoxItem.Info getSharedItem(BoxAPIConnection api,
                                         String sharedLink)

Gets an item that was shared with a shared link.

Parameters:

api - the API connection to be used by the shared item.

sharedLink - the shared link to the item.

Returns:

info about the shared item.

getSharedItem

public static BoxItem.Info getSharedItem(BoxAPIConnection api,
                                         String sharedLink,
                                         String password)

Gets an item that was shared with a password-protected shared link.

Parameters:

api - the API connection to be used by the shared item.

sharedLink - the shared link to the item.

password - the password for the shared link.

Returns:

info about the shared item.

getWatermark

protected BoxWatermark getWatermark(URLTemplate itemUrl,
                                    String... fields)

Used to retrieve the watermark for the item. If the item does not have a watermark applied to it, a 404 Not Found will be returned by API.

Parameters:

itemUrl - url template for the item.

fields - the fields to retrieve.

Returns:

the watermark associated with the item.

applyWatermark

protected BoxWatermark applyWatermark(URLTemplate itemUrl,
                                      String imprint)

Used to apply or update the watermark for the item.

Parameters:

itemUrl - url template for the item.

imprint - the value must be "default", as custom watermarks is not yet supported.

Returns:

the watermark associated with the item.

removeWatermark

protected void removeWatermark(URLTemplate itemUrl)

Removes a watermark from the item. If the item did not have a watermark applied to it, a 404 Not Found will be returned by API.

Parameters:

itemUrl - url template for the item.

copy

public abstract BoxItem.Info copy(BoxFolder destination)

Copies this item to another folder.

Parameters:

destination - the destination folder.

Returns:

info about the copied item.

copy

public abstract BoxItem.Info copy(BoxFolder destination,
                                  String newName)

Copies this item to another folder and gives it a new name. If the destination is the same folder as the item's current parent, then newName must be a new, unique name.

Parameters:

destination - the destination folder.

newName - a new name for the copied item.

Returns:

info about the copied item.

move

public abstract BoxItem.Info move(BoxFolder destination)

Moves this item to another folder.

Parameters:

destination - the destination folder.

Returns:

info about the moved item.

move

public abstract BoxItem.Info move(BoxFolder destination,
                                  String newName)

Moves this item to another folder and gives it a new name.

Parameters:

destination - the destination folder.

newName - a new name for the moved item.

Returns:

info about the moved item.

createSharedLink

public abstract BoxSharedLink createSharedLink(BoxSharedLink.Access access,
                                               Date unshareDate,
                                               BoxSharedLink.Permissions permissions)

Creates a new shared link for this item.

This method is a convenience method for manually creating a new shared link and applying it to this item with BoxItem.Info.setSharedLink(com.box.sdk.BoxSharedLink). You may want to create the shared link manually so that it can be updated along with other changes to the item's info in a single network request, giving a boost to performance.

Parameters:

access - the access level of the shared link.

unshareDate - the date and time at which the link will expire. Can be null to create a non-expiring link.

permissions - the permissions of the shared link. Can be null to use the default permissions.

Returns:

the created shared link.

getInfo

public abstract BoxItem.Info getInfo()

Gets information about this item.

Returns:

info about this item.

getInfo

public abstract BoxItem.Info getInfo(String... fields)

Gets information about this item that's limited to a list of specified fields.

Parameters:

fields - the fields to retrieve.

Returns:

info about this item containing only the specified fields.

setCollections

public abstract BoxItem.Info setCollections(BoxCollection... collections)

Sets the collections that this item belongs to.

Parameters:

collections - the collections that this item should belong to.

Returns:

info about the item, including the collections it belongs to.