com.box.sdk.sharedlink

Class BoxSharedLinkRequest

Object

BoxSharedLinkRequest

public class BoxSharedLinkRequest
extends Object

Represents request to create shared link with permissions.

Constructor Summary

Constructors

Constructor and Description
BoxSharedLinkRequest()

Method Summary

Modifier and Type	Method and Description
T	access(BoxSharedLink.Access access) Sets the access level of this shared link.
BoxSharedLink	asSharedLink()
T	password(String password) Sets the password of this shared link.
BoxSharedLinkRequest	permissions(boolean canDownload, boolean canPreview) Sets the permissions associated with this shared link.
BoxSharedLinkRequest	permissions(boolean canDownload, boolean canPreview, boolean canEdit) Sets the permissions associated with this shared link.
T	unsharedDate(Date unsharedDate) Sets the time that this shared link will be deactivated.
T	vanityName(String vanityName) Sets vanity name used to create vanity URL.

Methods inherited from class Object

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

Constructor Detail

BoxSharedLinkRequest

public BoxSharedLinkRequest()

Method Detail

permissions

public BoxSharedLinkRequest permissions(boolean canDownload,
                                        boolean canPreview,
                                        boolean canEdit)

Sets the permissions associated with this shared link.

Parameters:

canDownload - whether the shared link can be downloaded.

canPreview - whether the shared link can be previewed.

canEdit - whether the file shared with the link can be edited.

Returns:

this request.

permissions

public BoxSharedLinkRequest permissions(boolean canDownload,
                                        boolean canPreview)

Sets the permissions associated with this shared link.

Parameters:

canDownload - whether the shared link can be downloaded.

canPreview - whether the shared link can be previewed.

Returns:

this request.

access

public T access(BoxSharedLink.Access access)

Sets the access level of this shared link.

Parameters:

access - the new access level of this shared link.

Returns:

this request.

password

public T password(String password)

Sets the password of this shared link.

Parameters:

password - the password of this shared link.

Returns:

this request.

unsharedDate

public T unsharedDate(Date unsharedDate)

Sets the time that this shared link will be deactivated.

Parameters:

unsharedDate - the time that this shared link will be deactivated.

Returns:

this request.

vanityName

public T vanityName(String vanityName)

Sets vanity name used to create vanity URL. For example: vanityName = myCustomName will produce vanityUrl as: https://app.box.com/v/myCustomName Custom URLs should not be used when sharing sensitive content as vanity URLs are a lot easier to guess than regular shared links.

Parameters:

vanityName - Vanity name. Vanity name must be at least 12 characters long.

Returns:

this request.

asSharedLink

public BoxSharedLink asSharedLink()