com.box.androidsdk.content.models

Class BoxBookmark

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxItem

com.box.androidsdk.content.models.BoxBookmark

All Implemented Interfaces:

java.io.Serializable

public class BoxBookmark
extends BoxItem

Class that represents a bookmark on Box.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxBookmark.Permission Enumerates the possible permissions that a user can have on a bookmark.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_COMMENT_COUNT
static java.lang.String	FIELD_URL
static java.lang.String	TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxItem

FIELD_ALLOWED_SHARED_LINK_ACCESS_LEVELS, FIELD_CREATED_AT, FIELD_CREATED_BY, FIELD_DESCRIPTION, FIELD_ETAG, FIELD_ITEM_STATUS, FIELD_MODIFIED_AT, FIELD_MODIFIED_BY, FIELD_NAME, FIELD_OWNED_BY, FIELD_PARENT, FIELD_PATH_COLLECTION, FIELD_PERMISSIONS, FIELD_PURGED_AT, FIELD_SEQUENCE_ID, FIELD_SHARED_LINK, FIELD_SYNCED, FIELD_TRASHED_AT

Fields inherited from class com.box.androidsdk.content.models.BoxEntity

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

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

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxBookmark() Constructs an empty BoxBookmark object.
BoxBookmark(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxBookmark with the provided map values.

Method Summary

Methods

Modifier and Type	Method and Description
static BoxBookmark	createFromId(java.lang.String bookmarkId) A convenience method to create an empty bookmark with just the id and type fields set.
java.lang.Long	getCommentCount() Gets the number of comments on the item.
java.util.EnumSet<BoxBookmark.Permission>	getPermissions() Gets the permissions that the current user has on the bookmark.
java.lang.Long	getSize() This always returns null as size doesn't make sense for bookmarks.
java.lang.String	getUrl() Gets the URL of the bookmark.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

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

createBoxItemFromJson, createBoxItemFromJson, getAllowedSharedLinkAccessLevels, getContentCreatedAt, getContentModifiedAt, getCreatedAt, getCreatedBy, getDescription, getEtag, getIsSynced, getItemStatus, getModifiedAt, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSequenceID, getSharedLink, getTrashedAt, parseJsonObject

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

createEntityFromJson, createEntityFromJson, getId, getType

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

createFromJson, createFromJson, getPropertiesAsHashMap, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_URL

public static final java.lang.String FIELD_URL

See Also:

Constant Field Values

FIELD_COMMENT_COUNT

public static final java.lang.String FIELD_COMMENT_COUNT

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxBookmark

public BoxBookmark()

Constructs an empty BoxBookmark object.

BoxBookmark

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

Constructs a BoxBookmark with the provided map values.

Parameters:

map - map of keys and values of the object.

Method Detail

createFromId

public static BoxBookmark createFromId(java.lang.String bookmarkId)

A convenience method to create an empty bookmark with just the id and type fields set. This allows the ability to interact with the content sdk in a more descriptive and type safe manner

Parameters:

bookmarkId - the id of folder to create

Returns:

an empty BoxBookmark object that only contains id and type information

getUrl

public java.lang.String getUrl()

Gets the URL of the bookmark.

Returns:

the URL of the bookmark.

getCommentCount

public java.lang.Long getCommentCount()

Description copied from class: BoxItem

Gets the number of comments on the item.

Overrides:

getCommentCount in class BoxItem

Returns:

the number of comments on the item.

getSize

public java.lang.Long getSize()

This always returns null as size doesn't make sense for bookmarks.

Overrides:

getSize in class BoxItem

Returns:

null.

getPermissions

public java.util.EnumSet<BoxBookmark.Permission> getPermissions()

Gets the permissions that the current user has on the bookmark.

Returns:

the permissions that the current user has on the bookmark.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJsonObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxItem

Parameters:

member - the JSON member to be parsed.