com.box.boxjavalibv2.resourcemanagers

Interface IBoxWebLinksManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxWebLinksManagerImpl

public interface IBoxWebLinksManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxWebLink	copyWebLink(java.lang.String webLinkId, BoxItemCopyRequestObject requestObject) Copy a web link.
BoxWebLink	createSharedLink(java.lang.String webLinkId, BoxSharedLinkRequestObject requestObject) Create a shared link for a web link, given the id of the web link.
void	deleteWebLink(java.lang.String webLinkId, BoxDefaultRequestObject requestObject) Delete a web link.
BoxWebLink	getWebLink(java.lang.String webLinkId, BoxDefaultRequestObject requestObject) Get web link given a web link id.
BoxWebLink	updateWebLinkInfo(java.lang.String webLinkId, BoxWebLinkRequestObject requestObject) Update info for a web link.

Method Detail

getWebLink

BoxWebLink getWebLink(java.lang.String webLinkId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Get web link given a web link id.

Parameters:

webLinkId - id of the web link

requestObject - object that goes into request.

Returns:

requested box web link

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

deleteWebLink

void deleteWebLink(java.lang.String webLinkId,
                 BoxDefaultRequestObject requestObject)
                   throws BoxRestException,
                          BoxServerException,
                          AuthFatalFailureException

Delete a web link.

Parameters:

webLinkId - id of the web link

requestObject - object that goes into request.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

copyWebLink

BoxWebLink copyWebLink(java.lang.String webLinkId,
                     BoxItemCopyRequestObject requestObject)
                       throws BoxRestException,
                              BoxServerException,
                              AuthFatalFailureException

Copy a web link.

Parameters:

webLinkId - id of the web link

requestObject - request object

Returns:

copied web link

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

updateWebLinkInfo

BoxWebLink updateWebLinkInfo(java.lang.String webLinkId,
                           BoxWebLinkRequestObject requestObject)
                             throws java.io.UnsupportedEncodingException,
                                    BoxRestException,
                                    BoxServerException,
                                    AuthFatalFailureException

Update info for a web link.

Parameters:

webLinkId - id of the web link

requestObject - request object

Returns:

updated web link

Throws:

java.io.UnsupportedEncodingException - exception

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.

createSharedLink

BoxWebLink createSharedLink(java.lang.String webLinkId,
                          BoxSharedLinkRequestObject requestObject)
                            throws BoxRestException,
                                   BoxServerException,
                                   AuthFatalFailureException

Create a shared link for a web link, given the id of the web link.

Parameters:

webLinkId - id of the web link

requestObject - request object

Returns:

the web link, with shared link related fields filled in.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See BoxServerException for more info.

AuthFatalFailureException - See AuthFatalFailureException for more info.