com.box.boxjavalibv2.dao

Class BoxSharedLink

java.lang.Object

com.box.boxjavalibv2.dao.BoxBase

com.box.boxjavalibv2.dao.BoxObject

com.box.boxjavalibv2.dao.BoxSharedLink

All Implemented Interfaces:

IBoxParcelable

public class BoxSharedLink
extends BoxObject

Shared link.

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_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()
BoxSharedLink(BoxSharedLink obj) Copy constructor, this does deep copy for all the fields.
BoxSharedLink(IBoxParcelWrapper in)
BoxSharedLink(java.util.Map<java.lang.String,java.lang.Object> map) Instantiate the object from a map.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccess() Get access.
java.lang.Integer	getDownloadCount() Get download count.
java.lang.String	getDownloadUrl() Get the url to download the shared item.
java.lang.String	getEffectiveAccess() Get effective access.
BoxSharedLinkPermissions	getPermissions() Get permissions.
java.lang.Integer	getPreviewCount() Get the preview count.
java.lang.String	getUnsharedAt() Get the time to unshare this link.
java.lang.String	getUrl() Get the url of the shared link.
java.lang.String	getVanityUrl() Get vanity url.
java.lang.Boolean	isPasswordEnabled() Whether this shared link is password enabled.

Methods inherited from class com.box.boxjavalibv2.dao.BoxObject

canBeHandledAsUnknown, contains, equals, extraProperties, getExtraData, getValue, handleUnknown, hashCode, properties, put, writeToParcel

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_EFFECTIVE_ACCESS

public static final java.lang.String FIELD_EFFECTIVE_ACCESS

See Also:

Constant Field Values

FIELD_PERMISSIONS

public static final java.lang.String FIELD_PERMISSIONS

See Also:

Constant Field Values

Constructor Detail

BoxSharedLink

public BoxSharedLink()

BoxSharedLink

public BoxSharedLink(BoxSharedLink obj)

Copy constructor, this does deep copy for all the fields.

Parameters:

obj -

BoxSharedLink

public BoxSharedLink(java.util.Map<java.lang.String,java.lang.Object> map)

Instantiate the object from a map. Each entry in the map reflects to a field.

Parameters:

map -

BoxSharedLink

public BoxSharedLink(IBoxParcelWrapper in)

Method Detail

getUrl

public java.lang.String getUrl()

Get the url of the shared link.

Returns:

the url

getDownloadUrl

public java.lang.String getDownloadUrl()

Get the url to download the shared item.

Returns:

the download_url

isPasswordEnabled

public java.lang.Boolean isPasswordEnabled()

Whether this shared link is password enabled.

Returns:

the password_enabled

getDownloadCount

public java.lang.Integer getDownloadCount()

Get download count.

Returns:

the download_count

getUnsharedAt

public java.lang.String getUnsharedAt()

Get the time to unshare this link. This returns a String and can be parsed into Date by ISO8601DateParser

Returns:

the unshared_at

getPreviewCount

public java.lang.Integer getPreviewCount()

Get the preview count.

Returns:

the preview_count

getAccess

public java.lang.String getAccess()

Get access. This can only be the strings defined in BoxSharedLinkAccess

Returns:

the access

getVanityUrl

public java.lang.String getVanityUrl()

Get vanity url.

Returns:

the vanity url

getEffectiveAccess

public java.lang.String getEffectiveAccess()

Get effective access. This can only be the strings defined in BoxSharedLinkAccess

Returns:

the access

getPermissions

public BoxSharedLinkPermissions getPermissions()

Get permissions.

Returns:

the permissions