com.box.androidsdk.content.models

Class BoxSharedLink

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxSharedLink

All Implemented Interfaces:

java.io.Serializable

public class BoxSharedLink
extends BoxJsonObject

Class that represents a link to a file, folder, or bookmark on Box.

See Also:

Serialized Form

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.

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_ACCESS
static java.lang.String	FIELD_DOWNLOAD_COUNT
static java.lang.String	FIELD_DOWNLOAD_URL
static java.lang.String	FIELD_EFFECTIVE_ACCESS
static java.lang.String	FIELD_IS_PASSWORD_ENABLED
static java.lang.String	FIELD_PASSWORD
static java.lang.String	FIELD_PERMISSIONS
static java.lang.String	FIELD_PREVIEW_COUNT
static java.lang.String	FIELD_UNSHARED_AT
static java.lang.String	FIELD_URL
static java.lang.String	FIELD_VANITY_URL

Constructor Summary

Constructors

Constructor and Description
BoxSharedLink() Constructs a BoxSharedLink with default settings.
BoxSharedLink(com.eclipsesource.json.JsonObject object) Constructs a BoxSharedLink with the provided map values.

Method Summary

Modifier and Type	Method and Description
BoxSharedLink.Access	getAccess() Gets the access level of this shared link.
java.lang.Long	getDownloadCount() Gets the number of times that this shared link has been downloaded.
java.lang.String	getDownloadURL() Gets the direct download URL of this shared link.
BoxSharedLink.Access	getEffectiveAccess() Gets the effective access level of this shared link, can differ from actual access and this value controls actual behavior of the link.
java.lang.Boolean	getIsPasswordEnabled() Gets whether or not a password is enabled on this shared link.
java.lang.String	getPassword() Gets the password for this shared link.
BoxSharedLink.Permissions	getPermissions() Gets the permissions associated with this shared link.
java.lang.Long	getPreviewCount() Gets the number of times that this shared link has been previewed.
java.util.Date	getUnsharedDate() Gets the time that this shared link will be deactivated.
java.lang.String	getURL() Get the URL of this shared link.
java.lang.String	getVanityURL() Gets the vanity URL of this shared link.

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_URL

public static final java.lang.String FIELD_URL

See Also:

Constant Field Values

FIELD_DOWNLOAD_URL

public static final java.lang.String FIELD_DOWNLOAD_URL

See Also:

Constant Field Values

FIELD_VANITY_URL

public static final java.lang.String FIELD_VANITY_URL

See Also:

Constant Field Values

FIELD_IS_PASSWORD_ENABLED

public static final java.lang.String FIELD_IS_PASSWORD_ENABLED

See Also:

Constant Field Values

FIELD_UNSHARED_AT

public static final java.lang.String FIELD_UNSHARED_AT

See Also:

Constant Field Values

FIELD_DOWNLOAD_COUNT

public static final java.lang.String FIELD_DOWNLOAD_COUNT

See Also:

Constant Field Values

FIELD_PREVIEW_COUNT

public static final java.lang.String FIELD_PREVIEW_COUNT

See Also:

Constant Field Values

FIELD_ACCESS

public static final java.lang.String FIELD_ACCESS

See Also:

Constant Field Values

FIELD_PERMISSIONS

public static final java.lang.String FIELD_PERMISSIONS

See Also:

Constant Field Values

FIELD_EFFECTIVE_ACCESS

public static final java.lang.String FIELD_EFFECTIVE_ACCESS

See Also:

Constant Field Values

FIELD_PASSWORD

public static final java.lang.String FIELD_PASSWORD

See Also:

Constant Field Values

Constructor Detail

BoxSharedLink

public BoxSharedLink()

Constructs a BoxSharedLink with default settings.

BoxSharedLink

public BoxSharedLink(com.eclipsesource.json.JsonObject object)

Constructs a BoxSharedLink with the provided map values.

Parameters:

object - JsonObject representing this class

Method Detail

getURL

public java.lang.String getURL()

Get the URL of this shared link.

Returns:

the URL of this shared link.

getDownloadURL

public java.lang.String getDownloadURL()

Gets the direct download URL of this shared link.

Returns:

the direct download URL of this shared link.

getVanityURL

public java.lang.String getVanityURL()

Gets the vanity URL of this shared link.

Returns:

the vanity URL of this shared link.

getIsPasswordEnabled

public java.lang.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 java.util.Date getUnsharedDate()

Gets the time that this shared link will be deactivated.

Returns:

the time that this shared link will be deactivated.

getDownloadCount

public java.lang.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 java.lang.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.

getPassword

public java.lang.String getPassword()

Gets the password for this shared link.

Returns:

the password of this shared link.

getEffectiveAccess

public BoxSharedLink.Access getEffectiveAccess()

Gets the effective access level of this shared link, can differ from actual access and this value controls actual behavior of the link.

Returns:

the effective access level of this shared link.

getPermissions

public BoxSharedLink.Permissions getPermissions()

Gets the permissions associated with this shared link.

Returns:

the permissions associated with this shared link.