com.box.sdkgen.schemas.weblink

Class WebLink

Object

NullableFieldTracker

SerializableObject

WebLinkBase

WebLinkMini

WebLink

All Implemented Interfaces:

Serializable

public class WebLink
extends WebLinkMini

Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application.

Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebLink.AllowedSharedLinkAccessLevelsDeserializer
static class	WebLink.AllowedSharedLinkAccessLevelsSerializer
static class	WebLink.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<EnumWrapper<WebLinkAllowedSharedLinkAccessLevelsField>>	allowedSharedLinkAccessLevels The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this web link.
protected List<Collection>	collections The collections that this web link belongs to.
protected OffsetDateTime	createdAt When this file was created on Box’s servers.
protected UserMini	createdBy
protected String	description The description accompanying the web link.
protected EnumWrapper<WebLinkItemStatusField>	itemStatus Whether this item is deleted or not.
protected OffsetDateTime	modifiedAt When this file was last updated on the Box servers.
protected UserMini	modifiedBy
protected UserMini	ownedBy
protected FolderMini	parent
protected WebLinkPathCollectionField	pathCollection
protected OffsetDateTime	purgedAt When this file will be permanently deleted.
protected WebLinkSharedLinkField	sharedLink
protected OffsetDateTime	trashedAt When this file was moved to the trash.

Fields inherited from class WebLinkMini

name, sequenceId, url

Fields inherited from class WebLinkBase

etag, id, type

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebLink(String id)
protected	WebLink(WebLink.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<EnumWrapper<WebLinkAllowedSharedLinkAccessLevelsField>>	getAllowedSharedLinkAccessLevels()
List<Collection>	getCollections()
OffsetDateTime	getCreatedAt()
UserMini	getCreatedBy()
String	getDescription()
EnumWrapper<WebLinkItemStatusField>	getItemStatus()
OffsetDateTime	getModifiedAt()
UserMini	getModifiedBy()
UserMini	getOwnedBy()
FolderMini	getParent()
WebLinkPathCollectionField	getPathCollection()
OffsetDateTime	getPurgedAt()
WebLinkSharedLinkField	getSharedLink()
OffsetDateTime	getTrashedAt()
int	hashCode()
String	toString()

Methods inherited from class WebLinkMini

getName, getSequenceId, getUrl

Methods inherited from class WebLinkBase

getEtag, getId, getType

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

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

Field Detail

parent

protected FolderMini parent

description

protected String description

The description accompanying the web link. This is visible within the Box web application.

pathCollection

protected WebLinkPathCollectionField pathCollection

createdAt

protected OffsetDateTime createdAt

When this file was created on Box’s servers.

modifiedAt

protected OffsetDateTime modifiedAt

When this file was last updated on the Box servers.

trashedAt

protected OffsetDateTime trashedAt

When this file was moved to the trash.

purgedAt

protected OffsetDateTime purgedAt

When this file will be permanently deleted.

createdBy

protected UserMini createdBy

modifiedBy

protected UserMini modifiedBy

ownedBy

protected UserMini ownedBy

sharedLink

protected WebLinkSharedLinkField sharedLink

itemStatus

protected EnumWrapper<WebLinkItemStatusField> itemStatus

Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted.

collections

protected List<Collection> collections

The collections that this web link belongs to.

For more information, see the [collections guide](https://developer.box.com/guides/collections).

allowedSharedLinkAccessLevels

protected List<EnumWrapper<WebLinkAllowedSharedLinkAccessLevelsField>> allowedSharedLinkAccessLevels

The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this web link.

The list depends on item policy and user authorization, so it may be narrower than the levels available to the owner. An empty array means no access level is available to this user.

Constructor Detail

WebLink

public WebLink(String id)

WebLink

protected WebLink(WebLink.Builder builder)

Method Detail

getParent

public FolderMini getParent()

getDescription

public String getDescription()

getPathCollection

public WebLinkPathCollectionField getPathCollection()

getCreatedAt

public OffsetDateTime getCreatedAt()

getModifiedAt

public OffsetDateTime getModifiedAt()

getTrashedAt

public OffsetDateTime getTrashedAt()

getPurgedAt

public OffsetDateTime getPurgedAt()

getCreatedBy

public UserMini getCreatedBy()

getModifiedBy

public UserMini getModifiedBy()

getOwnedBy

public UserMini getOwnedBy()

getSharedLink

public WebLinkSharedLinkField getSharedLink()

getItemStatus

public EnumWrapper<WebLinkItemStatusField> getItemStatus()

getCollections

public List<Collection> getCollections()

getAllowedSharedLinkAccessLevels

public List<EnumWrapper<WebLinkAllowedSharedLinkAccessLevelsField>> getAllowedSharedLinkAccessLevels()

equals

public boolean equals(Object o)

Overrides:

equals in class WebLinkMini

hashCode

public int hashCode()

Overrides:

hashCode in class WebLinkMini

toString

public String toString()

Overrides:

toString in class WebLinkMini