BoxSharedLink (Box Java SDK)

Object
- BoxJSONObject
- - BoxSharedLink

public class BoxSharedLink
extends BoxJSONObject

Represents a link to a file or folder on Box.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BoxSharedLink.Access` Enumerates the possible access levels that can be set on a shared link.
`static class`	`BoxSharedLink.Permissions` Contains permissions fields that can be set on a shared link.

Constructor Summary

Constructors
Constructor and Description

BoxSharedLink()
Constructs a BoxSharedLink with default settings.

BoxSharedLink(String json)
Constructs a BoxSharedLink from a JSON string.

Constructors
Constructor and Description
`BoxSharedLink()` Constructs a BoxSharedLink with default settings.
`BoxSharedLink(String json)` Constructs a BoxSharedLink from a JSON string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BoxSharedLink.Access`	`getAccess()` Gets the access level of this shared link.
`long`	`getDownloadCount()` Gets the number of times that this shared link has been downloaded.
`String`	`getDownloadURL()` Gets the direct download URL of this shared link.
`BoxSharedLink.Access`	`getEffectiveAccess()` Gets the effective access level of this shared link.
`boolean`	`getIsPasswordEnabled()` Gets whether or not a password is enabled on this shared link.
`protected JsonObject`	`getPendingJSONObject()` Gets a JsonObject containing any pending changes to this object that can be sent back to the Box API.
`BoxSharedLink.Permissions`	`getPermissions()` Gets the permissions associated with this shared link.
`long`	`getPreviewCount()` Gets the number of times that this shared link has been previewed.
`static String`	`getSharedLinkHeaderValue(String sharedLink, String password)`
`Date`	`getUnsharedDate()` Gets the time that this shared link will be deactivated.
`String`	`getURL()` Get the URL of this shared link.
`String`	`getVanityName()` Returns vanity name used to create vanity URL.
`String`	`getVanityURL()` Gets the vanity URL of this shared link.
`void`	`setAccess(BoxSharedLink.Access access)` Sets the access level of this shared link.
`void`	`setPassword(String password)` Sets the password of this shared link.
`void`	`setPermissions(BoxSharedLink.Permissions permissions)` Sets the permissions associated with this shared link.
`void`	`setUnsharedDate(Date unsharedDate)` Sets the time that this shared link will be deactivated.
`void`	`setVanityName(String vanityName)` Sets vanity name used to create vanity URL.

Methods inherited from class BoxJSONObject
clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BoxSharedLink
```
public BoxSharedLink()
```
    Constructs a BoxSharedLink with default settings.
  - BoxSharedLink
```
public BoxSharedLink(String json)
```
    Constructs a BoxSharedLink from a JSON string.
    
    Parameters:
    
    json - the JSON encoded shared link.
- Method Detail
  - getURL
```
public String getURL()
```
    Get the URL of this shared link.
    
    Returns:
    
    the URL of this shared link.
  - getDownloadURL
```
public String getDownloadURL()
```
    Gets the direct download URL of this shared link.
    
    Returns:
    
    the direct download URL of this shared link.
  - getVanityURL
```
public String getVanityURL()
```
    Gets the vanity URL of this shared link.
    
    Returns:
    
    the vanity URL of this shared link.
  - getVanityName
```
public String getVanityName()
```
    Returns vanity name used to create vanity URL.
    
    Returns:
    
    Vanity name
  - setVanityName
```
public void setVanityName(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.
  - getIsPasswordEnabled
```
public boolean getIsPasswordEnabled()
```
    Gets whether or not a password is enabled on this shared link.
    
    Returns:
    
    true if there's a password enabled on this shared link; otherwise false.
  - getUnsharedDate
```
public Date getUnsharedDate()
```
    Gets the time that this shared link will be deactivated.
    
    Returns:
    
    the time that this shared link will be deactivated.
  - setUnsharedDate
```
public void setUnsharedDate(Date unsharedDate)
```
    Sets the time that this shared link will be deactivated.
    
    Parameters:
    
    unsharedDate - the time that this shared link will be deactivated.
  - getDownloadCount
```
public long getDownloadCount()
```
    Gets the number of times that this shared link has been downloaded.
    
    Returns:
    
    the number of times that this link has been downloaded.
  - getPreviewCount
```
public long getPreviewCount()
```
    Gets the number of times that this shared link has been previewed.
    
    Returns:
    
    the number of times that this link has been previewed.
  - getAccess
```
public BoxSharedLink.Access getAccess()
```
    Gets the access level of this shared link.
    
    Returns:
    
    the access level of this shared link.
  - setAccess
```
public void setAccess(BoxSharedLink.Access access)
```
    Sets the access level of this shared link.
    
    Parameters:
    
    access - the new access level of this shared link.
  - setPassword
```
public void setPassword(String password)
```
    Sets the password of this shared link.
    
    Parameters:
    
    password - the password of this shared link.
  - getEffectiveAccess
```
public BoxSharedLink.Access getEffectiveAccess()
```
    Gets the effective access level of this shared link.
    
    Returns:
    
    the effective access level of this shared link.
    Note there is no setEffectiveAccess metho becaused this cannot be changed via the API
  - getPermissions
```
public BoxSharedLink.Permissions getPermissions()
```
    Gets the permissions associated with this shared link.
    
    Returns:
    
    the permissions associated with this shared link.
  - setPermissions
```
public void setPermissions(BoxSharedLink.Permissions permissions)
```
    Sets the permissions associated with this shared link.
    
    Parameters:
    
    permissions - the new permissions for this shared link.
  - getPendingJSONObject
```
protected JsonObject getPendingJSONObject()
```
    Description copied from class: BoxJSONObject
    
    Gets a JsonObject containing any pending changes to this object that can be sent back to the Box API.
    
    Overrides:
    
    getPendingJSONObject in class BoxJSONObject
    
    Returns:
    
    a JsonObject containing the pending changes.
  - getSharedLinkHeaderValue
```
public static String getSharedLinkHeaderValue(String sharedLink,
                                              String password)
```

Class BoxSharedLink

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class BoxJSONObject

Methods inherited from class Object

Constructor Detail

BoxSharedLink

BoxSharedLink

Method Detail

getURL

getDownloadURL

getVanityURL

getVanityName

setVanityName

getIsPasswordEnabled

getUnsharedDate

setUnsharedDate

getDownloadCount

getPreviewCount

getAccess

setAccess

setPassword

getEffectiveAccess

getPermissions

setPermissions

getPendingJSONObject

getSharedLinkHeaderValue