org.nuxeo.box.api.marshalling.dao

Class BoxSharedLink

java.lang.Object

org.nuxeo.box.api.marshalling.dao.BoxBase

org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

org.nuxeo.box.api.marshalling.dao.BoxObject

org.nuxeo.box.api.marshalling.dao.BoxSharedLink

All Implemented Interfaces:

IBoxJSONStringEntity

public class BoxSharedLink
extends BoxObject

Shared link.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_ACCESS
static String	FIELD_DOWNLOAD_COUNT
static String	FIELD_DOWNLOAD_URL
static String	FIELD_PASSWORD_ENABLED
static String	FIELD_PERMISSIONS
static String	FIELD_PREVIEW_COUNT
static String	FIELD_UNSHARED_AT
static String	FIELD_URL

Constructor Summary

Constructors

Constructor and Description
BoxSharedLink()
BoxSharedLink(BoxSharedLink obj) Copy constructor, this does deep copy for all the fields.
BoxSharedLink(Map<String,Object> map) Instantiate the object from a map.

Method Summary

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

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxObject

contains, equals, getExtraData, getKeySet, getValue, handleUnknown, hashCode, properties, put, putAll

Methods inherited from class org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

toJSONString

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_URL

public static final String FIELD_URL

See Also:

Constant Field Values

FIELD_DOWNLOAD_URL

public static final String FIELD_DOWNLOAD_URL

See Also:

Constant Field Values

FIELD_PASSWORD_ENABLED

public static final String FIELD_PASSWORD_ENABLED

See Also:

Constant Field Values

FIELD_UNSHARED_AT

public static final String FIELD_UNSHARED_AT

See Also:

Constant Field Values

FIELD_DOWNLOAD_COUNT

public static final String FIELD_DOWNLOAD_COUNT

See Also:

Constant Field Values

FIELD_PREVIEW_COUNT

public static final String FIELD_PREVIEW_COUNT

See Also:

Constant Field Values

FIELD_ACCESS

public static final String FIELD_ACCESS

See Also:

Constant Field Values

FIELD_PERMISSIONS

public static final 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(Map<String,Object> map)

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

Parameters:

map -

Method Detail

getUrl

public String getUrl()

Get the url of the shared link.

Returns:

the url

getDownloadUrl

public String getDownloadUrl()

Get the url to download the shared item.

Returns:

the download_url

isPasswordEnabled

public Boolean isPasswordEnabled()

Whether this shared link is password enabled.

Returns:

the password_enabled

getDownloadCount

public Integer getDownloadCount()

Get download count.

Returns:

the download_count

getUnsharedAt

public String getUnsharedAt()

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

Returns:

the unshared_at

getPreviewCount

public Integer getPreviewCount()

Get the preview count.

Returns:

the preview_count

getAccess

public String getAccess()

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

Returns:

the access

getPermissions

public BoxSharedLinkPermissions getPermissions()

Get permissions.

Returns:

the permissions