com.box.sdk

Class BoxWebLink

Object

BoxResource

BoxItem

BoxWebLink

@BoxResourceType(value="web_link")
public class BoxWebLink
extends BoxItem

Represents an individual WebLink file on Box. This class can be used to retrieve the link's URL or perform other common file operations (move, copy, delete, etc.).

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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_FIELDS An array of all possible weblink fields that can be requested when calling getInfo(String...).
static URLTemplate	COPY_URL_TEMPLATE Copy URL Template.
static URLTemplate	WEB_LINK_URL_TEMPLATE Web Link URL Template.

Fields inherited from class BoxItem

SHARED_ITEM_URL_TEMPLATE, WATERMARK_URL_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
BoxWebLink(BoxAPIConnection api, String id) Constructs a BoxWebLink for a weblink with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxWebLink.Info	copy(BoxFolder destination) Copies this item to another folder.
BoxWebLink.Info	copy(BoxFolder destination, String newName) Copies this item to another folder and gives it a new name.
BoxSharedLink	createSharedLink(BoxSharedLinkWithoutPermissionsRequest sharedLinkRequest) Creates a shared link.
void	delete() Deletes this weblink by moving it to the trash.
BoxWebLink.Info	getInfo(String... fields) Gets information about this item that's limited to a list of specified fields.
BoxItem.Info	move(BoxFolder destination) Moves this item to another folder.
BoxItem.Info	move(BoxFolder destination, String newName) Moves this item to another folder and gives it a new name.
void	rename(String newName) Renames this weblink.
BoxWebLink.Info	setCollections(BoxCollection... collections) Sets the collections that this item belongs to.
void	updateInfo(BoxWebLink.Info info) Updates the information about this weblink with any info fields that have been modified locally.

Methods inherited from class BoxItem

applyWatermark, getItemURL, getSharedItem, getSharedItem, getWatermark, removeWatermark

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 weblink fields that can be requested when calling getInfo(String...).

COPY_URL_TEMPLATE

public static final URLTemplate COPY_URL_TEMPLATE

Copy URL Template.

WEB_LINK_URL_TEMPLATE

public static final URLTemplate WEB_LINK_URL_TEMPLATE

Web Link URL Template.

Constructor Detail

BoxWebLink

public BoxWebLink(BoxAPIConnection api,
                  String id)

Constructs a BoxWebLink for a weblink with a given ID.

Parameters:

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

id - the ID of the weblink.

Method Detail

createSharedLink

public BoxSharedLink createSharedLink(BoxSharedLinkWithoutPermissionsRequest sharedLinkRequest)

Creates a shared link.

Parameters:

sharedLinkRequest - Shared link to create

Returns:

Created shared link.

copy

public BoxWebLink.Info copy(BoxFolder destination)

Description copied from class: BoxItem

Copies this item to another folder.

Specified by:

copy in class BoxItem

Parameters:

destination - the destination folder.

Returns:

info about the copied item.

copy

public BoxWebLink.Info copy(BoxFolder destination,
                            String newName)

Description copied from class: BoxItem

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.

Specified by:

copy in class BoxItem

Parameters:

destination - the destination folder.

newName - a new name for the copied item.

Returns:

info about the copied item.

delete

public void delete()

Deletes this weblink by moving it to the trash.

move

public BoxItem.Info move(BoxFolder destination)

Description copied from class: BoxItem

Moves this item to another folder.

Specified by:

move in class BoxItem

Parameters:

destination - the destination folder.

Returns:

info about the moved item.

move

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

Description copied from class: BoxItem

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

Specified by:

move in class BoxItem

Parameters:

destination - the destination folder.

newName - a new name for the moved item.

Returns:

info about the moved item.

rename

public void rename(String newName)

Renames this weblink.

Parameters:

newName - the new name of the weblink.

getInfo

public BoxWebLink.Info getInfo(String... fields)

Description copied from class: BoxItem

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

Specified by:

getInfo in class BoxItem

Parameters:

fields - the fields to retrieve.

Returns:

info about this item containing only the specified fields.

updateInfo

public void updateInfo(BoxWebLink.Info info)

Updates the information about this weblink with any info fields that have been modified locally.

The only fields that will be updated are the ones that have been modified locally. For example, the following code won't update any information (or even send a network request) since none of the info's fields were changed:

BoxWebLink webLink = new BoxWebLink(api, id);
 BoxWebLink.Info info = webLink.getInfo();
 webLink.updateInfo(info);

Parameters:

info - the updated info.

setCollections

public BoxWebLink.Info setCollections(BoxCollection... collections)

Description copied from class: BoxItem

Sets the collections that this item belongs to.

Specified by:

setCollections in class BoxItem

Parameters:

collections - the collections that this item should belong to.

Returns:

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