com.box.androidsdk.content

Class BoxApiFolder

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiFolder

public class BoxApiFolder
extends BoxApi

Represents the API of the folder 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
BoxApiFolder(BoxSession session) Constructs a BoxApiFolder with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
BoxRequestsFolder.AddFolderToCollection	getAddToCollectionRequest(java.lang.String folderId, java.lang.String collectionId) Gets a request that adds a folder to a collection
BoxRequestsFolder.GetCollaborations	getCollaborationsRequest(java.lang.String id) Gets a request that gets the collaborations of a folder
BoxRequestsFolder.CopyFolder	getCopyRequest(java.lang.String id, java.lang.String parentId) Gets a request that copies a folder
BoxRequestsFolder.CreateFolder	getCreateRequest(java.lang.String parentId, java.lang.String name) Gets a request that creates a folder in a parent folder
BoxRequestsFolder.UpdateSharedFolder	getCreateSharedLinkRequest(java.lang.String id) Gets a request that creates a shared link for a folder
BoxRequestsFolder.DeleteFolderFromCollection	getDeleteFromCollectionRequest(java.lang.String id) Gets a request that removes a folder from a collection
BoxRequestsFolder.DeleteFolder	getDeleteRequest(java.lang.String id) Gets a request that deletes a folder
BoxRequestsFolder.DeleteTrashedFolder	getDeleteTrashedFolderRequest(java.lang.String id) Gets a request that permanently deletes a folder from the trash
BoxRequestsFolder.UpdateFolder	getDisableSharedLinkRequest(java.lang.String id) Gets a request that disables a shared link for a folder
protected java.lang.String	getFolderCollaborationsUrl(java.lang.String id) Gets the URL for the folders collaborations
protected java.lang.String	getFolderCopyUrl(java.lang.String id) Gets the URL for copying a folder
protected java.lang.String	getFolderInfoUrl(java.lang.String id) Gets the URL for folder information
protected java.lang.String	getFolderItemsUrl(java.lang.String id) Gets the URL for items
protected java.lang.String	getFoldersUrl() Gets the URL for folders
BoxRequestsFolder.GetFolderWithAllItems	getFolderWithAllItems(java.lang.String folderId) Gets a request that retrieves the all items of a folder up to max limit.
BoxRequestsFolder.GetFolderInfo	getInfoRequest(java.lang.String id) Gets a request that retrieves information on a folder
BoxRequestsFolder.GetFolderItems	getItemsRequest(java.lang.String id) Gets a request that retrieves the items of a folder
BoxRequestsFolder.UpdateFolder	getMoveRequest(java.lang.String id, java.lang.String parentId) Gets a request that moves a folder to another folder
BoxRequestsFolder.UpdateFolder	getRenameRequest(java.lang.String id, java.lang.String newName) Gets a request that renames a folder
BoxRequestsFolder.RestoreTrashedFolder	getRestoreTrashedFolderRequest(java.lang.String id) Gets a request that restores a trashed folder
BoxRequestsFolder.GetTrashedFolder	getTrashedFolderRequest(java.lang.String id) Gets a request that returns a folder in the trash
protected java.lang.String	getTrashedFolderUrl(java.lang.String id) Gets the URL for a trashed folder
BoxRequestsFolder.GetTrashedItems	getTrashedItemsRequest() Gets a request that returns the items in the trash
protected java.lang.String	getTrashedItemsUrl() Gets the URL for items in the trash
BoxRequestsFolder.UpdateFolder	getUpdateRequest(java.lang.String id) Gets a request that updates a folders 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

BoxApiFolder

public BoxApiFolder(BoxSession session)

Constructs a BoxApiFolder with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiFolder

Method Detail

getFoldersUrl

protected java.lang.String getFoldersUrl()

Gets the URL for folders

Returns:

the folder URL

getFolderInfoUrl

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

Gets the URL for folder information

Parameters:

id - id of the folder

Returns:

the folder information URL

getFolderItemsUrl

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

Gets the URL for items

Parameters:

id - id of the folder

Returns:

the folder items URL

getFolderCollaborationsUrl

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

Gets the URL for the folders collaborations

Parameters:

id - id of the folder

Returns:

the folder collaborations URL

getFolderCopyUrl

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

Gets the URL for copying a folder

Parameters:

id - id of the folder

Returns:

the copy folder URL

getTrashedFolderUrl

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

Gets the URL for a trashed folder

Parameters:

id - id of the folder

Returns:

the trashed folder URL

getTrashedItemsUrl

protected java.lang.String getTrashedItemsUrl()

Gets the URL for items in the trash

Returns:

the trashed items URL

getInfoRequest

public BoxRequestsFolder.GetFolderInfo getInfoRequest(java.lang.String id)

Gets a request that retrieves information on a folder

Parameters:

id - id of folder to retrieve info on

Returns:

request to get a folders information

getItemsRequest

public BoxRequestsFolder.GetFolderItems getItemsRequest(java.lang.String id)

Gets a request that retrieves the items of a folder

Parameters:

id - id of folder to get children on

Returns:

request to get a folders children

getFolderWithAllItems

public BoxRequestsFolder.GetFolderWithAllItems getFolderWithAllItems(java.lang.String folderId)

Gets a request that retrieves the all items of a folder up to max limit. (which is by default DEFAULT_MAX_LIMIT set -1 for unlimited)

Parameters:

folderId - id of folder to get children on

Returns:

request to get a folders children

getCreateRequest

public BoxRequestsFolder.CreateFolder getCreateRequest(java.lang.String parentId,
                                                       java.lang.String name)

Gets a request that creates a folder in a parent folder

Parameters:

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

name - name of the new folder

Returns:

request to create a folder

getUpdateRequest

public BoxRequestsFolder.UpdateFolder getUpdateRequest(java.lang.String id)

Gets a request that updates a folders information

Parameters:

id - id of folder to update information on

Returns:

request to update a folders information

getRenameRequest

public BoxRequestsFolder.UpdateFolder getRenameRequest(java.lang.String id,
                                                       java.lang.String newName)

Gets a request that renames a folder

Parameters:

id - id of folder to rename

newName - id of folder to retrieve info on

Returns:

request to rename a folder

getMoveRequest

public BoxRequestsFolder.UpdateFolder getMoveRequest(java.lang.String id,
                                                     java.lang.String parentId)

Gets a request that moves a folder to another folder

Parameters:

id - id of folder to move

parentId - id of parent folder to move folder into

Returns:

request to move a folder

getCopyRequest

public BoxRequestsFolder.CopyFolder getCopyRequest(java.lang.String id,
                                                   java.lang.String parentId)

Gets a request that copies a folder

Parameters:

id - id of folder to copy

parentId - id of parent folder to copy folder into

Returns:

request to copy a folder

getDeleteRequest

public BoxRequestsFolder.DeleteFolder getDeleteRequest(java.lang.String id)

Gets a request that deletes a folder

Parameters:

id - id of folder to delete

Returns:

request to delete a folder

getCollaborationsRequest

public BoxRequestsFolder.GetCollaborations getCollaborationsRequest(java.lang.String id)

Gets a request that gets the collaborations of a folder

Parameters:

id - id of folder to move

Returns:

request to move a folder

getCreateSharedLinkRequest

public BoxRequestsFolder.UpdateSharedFolder getCreateSharedLinkRequest(java.lang.String id)

Gets a request that creates a shared link for a folder

Parameters:

id - id of folder to create shared link for

Returns:

request to create a shared link for a folder

getDisableSharedLinkRequest

public BoxRequestsFolder.UpdateFolder getDisableSharedLinkRequest(java.lang.String id)

Gets a request that disables a shared link for a folder

Parameters:

id - id of folder to disable a shared link for

Returns:

request to create a shared link for a folder

getAddToCollectionRequest

public BoxRequestsFolder.AddFolderToCollection getAddToCollectionRequest(java.lang.String folderId,
                                                                         java.lang.String collectionId)

Gets a request that adds a folder to a collection

Parameters:

folderId - id of folder to add to collection

collectionId - id of collection to add the folder to

Returns:

request to add a folder to a collection

getDeleteFromCollectionRequest

public BoxRequestsFolder.DeleteFolderFromCollection getDeleteFromCollectionRequest(java.lang.String id)

Gets a request that removes a folder from a collection

Parameters:

id - id of folder to delete from the collection

Returns:

request to delete a folder from a collection

getTrashedItemsRequest

public BoxRequestsFolder.GetTrashedItems getTrashedItemsRequest()

Gets a request that returns the items in the trash

Returns:

request to get a folder from the trash

getTrashedFolderRequest

public BoxRequestsFolder.GetTrashedFolder getTrashedFolderRequest(java.lang.String id)

Gets a request that returns a folder in the trash

Parameters:

id - id of folder to get in the trash

Returns:

request to get a folder from the trash

getDeleteTrashedFolderRequest

public BoxRequestsFolder.DeleteTrashedFolder getDeleteTrashedFolderRequest(java.lang.String id)

Gets a request that permanently deletes a folder from the trash

Parameters:

id - id of folder to delete from the trash

Returns:

request to permanently delete a folder from the trash

getRestoreTrashedFolderRequest

public BoxRequestsFolder.RestoreTrashedFolder getRestoreTrashedFolderRequest(java.lang.String id)

Gets a request that restores a trashed folder

Parameters:

id - id of folder to restore

Returns:

request to restore a folder from the trash