com.box.androidsdk.content

Class BoxApiBookmark

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiBookmark

public class BoxApiBookmark
extends BoxApi

Represents the API of the bookmark endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiBookmark(BoxSession session) Constructs a BoxApiBookmark with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
BoxRequestsBookmark.AddCommentToBookmark	getAddCommentRequest(java.lang.String bookmarkId, java.lang.String message) Gets a request that adds a comment to a bookmark
BoxRequestsBookmark.AddBookmarkToCollection	getAddToCollectionRequest(java.lang.String bookmarkId, java.lang.String collectionId) Gets a request that adds a bookmark to a collection
protected java.lang.String	getBookmarkCommentsUrl(java.lang.String id) Gets the URL for comments on a bookmark
protected java.lang.String	getBookmarkCopyUrl(java.lang.String id) Gets the URL for copying a bookmark
protected java.lang.String	getBookmarkInfoUrl(java.lang.String id) Gets the URL for bookmark information
protected java.lang.String	getBookmarksUrl() Gets the URL for bookmarks
BoxRequestsBookmark.GetBookmarkComments	getCommentsRequest(java.lang.String id) Gets a request that retrieves the comments on a bookmark
protected java.lang.String	getCommentUrl() Gets the URL for posting a comment on a bookmark
BoxRequestsBookmark.CopyBookmark	getCopyRequest(java.lang.String id, java.lang.String parentId) Gets a request that copies a bookmark
BoxRequestsBookmark.CreateBookmark	getCreateRequest(java.lang.String parentId, java.lang.String url) Gets a request that creates a bookmark in a parent bookmark
BoxRequestsBookmark.UpdateSharedBookmark	getCreateSharedLinkRequest(java.lang.String id) Gets a request that creates a shared link for a bookmark
BoxRequestsBookmark.DeleteBookmarkFromCollection	getDeleteFromCollectionRequest(java.lang.String id) Gets a request that removes a bookmark from a collection
BoxRequestsBookmark.DeleteBookmark	getDeleteRequest(java.lang.String id) Gets a request that deletes a bookmark
BoxRequestsBookmark.DeleteTrashedBookmark	getDeleteTrashedBookmarkRequest(java.lang.String id) Gets a request that permanently deletes a bookmark from the trash
BoxRequestsBookmark.UpdateBookmark	getDisableSharedLinkRequest(java.lang.String id) Gets a request that disables a shared link for a bookmark
BoxRequestsBookmark.GetBookmarkInfo	getInfoRequest(java.lang.String id) Gets a request that retrieves information on a bookmark
BoxRequestsBookmark.UpdateBookmark	getMoveRequest(java.lang.String id, java.lang.String parentId) Gets a request that moves a bookmark to another folder
BoxRequestsBookmark.UpdateBookmark	getRenameRequest(java.lang.String id, java.lang.String newName) Gets a request that renames a bookmark
BoxRequestsBookmark.RestoreTrashedBookmark	getRestoreTrashedBookmarkRequest(java.lang.String id) Gets a request that restores a trashed bookmark
BoxRequestsBookmark.GetTrashedBookmark	getTrashedBookmarkRequest(java.lang.String id) Gets a request that returns a bookmark in the trash
protected java.lang.String	getTrashedBookmarkUrl(java.lang.String id) Gets the URL for a trashed bookmark
BoxRequestsBookmark.UpdateBookmark	getUpdateRequest(java.lang.String id) Gets a request that updates a bookmark's information

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxApiBookmark

public BoxApiBookmark(BoxSession session)

Constructs a BoxApiBookmark with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiBookmark

Method Detail

getBookmarksUrl

protected java.lang.String getBookmarksUrl()

Gets the URL for bookmarks

Returns:

the bookmark URL

getBookmarkInfoUrl

protected java.lang.String getBookmarkInfoUrl(java.lang.String id)

Gets the URL for bookmark information

Parameters:

id - id of the bookmark

Returns:

the bookmark information URL

getBookmarkCopyUrl

protected java.lang.String getBookmarkCopyUrl(java.lang.String id)

Gets the URL for copying a bookmark

Parameters:

id - id of the bookmark

Returns:

the copy bookmark URL

getTrashedBookmarkUrl

protected java.lang.String getTrashedBookmarkUrl(java.lang.String id)

Gets the URL for a trashed bookmark

Parameters:

id - id of the bookmark

Returns:

the trashed bookmark URL

getBookmarkCommentsUrl

protected java.lang.String getBookmarkCommentsUrl(java.lang.String id)

Gets the URL for comments on a bookmark

Parameters:

id - id of the bookmark

Returns:

the bookmark comments URL

getCommentUrl

protected java.lang.String getCommentUrl()

Gets the URL for posting a comment on a bookmark

Returns:

the comments URL

getInfoRequest

public BoxRequestsBookmark.GetBookmarkInfo getInfoRequest(java.lang.String id)

Gets a request that retrieves information on a bookmark

Parameters:

id - id of bookmark to retrieve info on

Returns:

request to get a bookmarks information

getCreateRequest

public BoxRequestsBookmark.CreateBookmark getCreateRequest(java.lang.String parentId,
                                                           java.lang.String url)

Gets a request that creates a bookmark in a parent bookmark

Parameters:

parentId - id of the parent bookmark to create the bookmark in

url - URL of the new bookmark

Returns:

request to create a bookmark

getUpdateRequest

public BoxRequestsBookmark.UpdateBookmark getUpdateRequest(java.lang.String id)

Gets a request that updates a bookmark's information

Parameters:

id - id of bookmark to update information on

Returns:

request to update a bookmark's information

getCopyRequest

public BoxRequestsBookmark.CopyBookmark getCopyRequest(java.lang.String id,
                                                       java.lang.String parentId)

Gets a request that copies a bookmark

Parameters:

id - id of the bookmark to copy

parentId - id of the parent folder to copy the bookmark into

Returns:

request to copy a bookmark

getRenameRequest

public BoxRequestsBookmark.UpdateBookmark getRenameRequest(java.lang.String id,
                                                           java.lang.String newName)

Gets a request that renames a bookmark

Parameters:

id - id of bookmark to rename

newName - id of bookmark to retrieve info on

Returns:

request to rename a bookmark

getMoveRequest

public BoxRequestsBookmark.UpdateBookmark getMoveRequest(java.lang.String id,
                                                         java.lang.String parentId)

Gets a request that moves a bookmark to another folder

Parameters:

id - id of bookmark to move

parentId - id of parent folder to move bookmark into

Returns:

request to move a bookmark

getDeleteRequest

public BoxRequestsBookmark.DeleteBookmark getDeleteRequest(java.lang.String id)

Gets a request that deletes a bookmark

Parameters:

id - id of bookmark to delete

Returns:

request to delete a bookmark

getCreateSharedLinkRequest

public BoxRequestsBookmark.UpdateSharedBookmark getCreateSharedLinkRequest(java.lang.String id)

Gets a request that creates a shared link for a bookmark

Parameters:

id - id of bookmark to create shared link for

Returns:

request to create a shared link for a bookmark

getDisableSharedLinkRequest

public BoxRequestsBookmark.UpdateBookmark getDisableSharedLinkRequest(java.lang.String id)

Gets a request that disables a shared link for a bookmark

Parameters:

id - id of bookmark to disable a shared link for

Returns:

request to create a shared link for a bookmark

getAddCommentRequest

public BoxRequestsBookmark.AddCommentToBookmark getAddCommentRequest(java.lang.String bookmarkId,
                                                                     java.lang.String message)

Gets a request that adds a comment to a bookmark

Parameters:

bookmarkId - id of the bookmark to add the comment to

message - message for the comment that will be added

Returns:

request to add a comment to a bookmark

getTrashedBookmarkRequest

public BoxRequestsBookmark.GetTrashedBookmark getTrashedBookmarkRequest(java.lang.String id)

Gets a request that returns a bookmark in the trash

Parameters:

id - id of bookmark to get in the trash

Returns:

request to get a bookmark from the trash

getDeleteTrashedBookmarkRequest

public BoxRequestsBookmark.DeleteTrashedBookmark getDeleteTrashedBookmarkRequest(java.lang.String id)

Gets a request that permanently deletes a bookmark from the trash

Parameters:

id - id of bookmark to delete from the trash

Returns:

request to permanently delete a bookmark from the trash

getRestoreTrashedBookmarkRequest

public BoxRequestsBookmark.RestoreTrashedBookmark getRestoreTrashedBookmarkRequest(java.lang.String id)

Gets a request that restores a trashed bookmark

Parameters:

id - id of bookmark to restore

Returns:

request to restore a bookmark from the trash

getCommentsRequest

public BoxRequestsBookmark.GetBookmarkComments getCommentsRequest(java.lang.String id)

Gets a request that retrieves the comments on a bookmark

Parameters:

id - id of the bookmark to retrieve comments for

Returns:

request to retrieve comments on a bookmark

getAddToCollectionRequest

public BoxRequestsBookmark.AddBookmarkToCollection getAddToCollectionRequest(java.lang.String bookmarkId,
                                                                             java.lang.String collectionId)

Gets a request that adds a bookmark to a collection

Parameters:

bookmarkId - id of bookmark to add to collection

collectionId - id of collection to add the bookmark to

Returns:

request to add a bookmark to a collection

getDeleteFromCollectionRequest

public BoxRequestsBookmark.DeleteBookmarkFromCollection getDeleteFromCollectionRequest(java.lang.String id)

Gets a request that removes a bookmark from a collection

Parameters:

id - id of bookmark to delete from the collection

Returns:

request to delete a bookmark from a collection