Skip to content

Latest commit

 

History

History
245 lines (160 loc) · 7.88 KB

folders.md

File metadata and controls

245 lines (160 loc) · 7.88 KB

FoldersManager

Get folder information

Retrieves details for a folder, including the first 100 entries in the folder.

Passing sort, direction, offset, and limit parameters in query allows you to manage the list of returned folder items.

To fetch more items within the folder, use the Get items in a folder endpoint.

This operation is performed by calling function getFolderById.

See the endpoint docs at API Reference.

client.getFolders().getFolderById("0")

Arguments

  • folderId String
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • queryParams GetFolderByIdQueryParams
    • Query parameters of getFolderById method
  • headers GetFolderByIdHeaders
    • Headers of getFolderById method

Returns

This function returns a value of type FolderFull.

Returns a folder, including the first 100 entries in the folder. If you used query parameters like sort, direction, offset, or limit the folder items list will be affected accordingly.

To fetch more items within the folder, use the Get items in a folder) endpoint.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

Update folder

Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.

This operation is performed by calling function updateFolderById.

See the endpoint docs at API Reference.

client.getFolders().updateFolderById(folderToUpdate.getId(), new UpdateFolderByIdRequestBody.UpdateFolderByIdRequestBodyBuilder().name(updatedName).description("Updated description").build())

Arguments

  • folderId String
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • requestBody UpdateFolderByIdRequestBody
    • Request body of updateFolderById method
  • queryParams UpdateFolderByIdQueryParams
    • Query parameters of updateFolderById method
  • headers UpdateFolderByIdHeaders
    • Headers of updateFolderById method

Returns

This function returns a value of type FolderFull.

Returns a folder object for the updated folder

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

This call will return synchronously. This holds true even when moving folders with a large a large number of items in all of its descendants. For very large folders, this means the call could take minutes or hours to return.

Delete folder

Deletes a folder, either permanently or by moving it to the trash.

This operation is performed by calling function deleteFolderById.

See the endpoint docs at API Reference.

client.getFolders().deleteFolderById(newFolder.getId())

Arguments

  • folderId String
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • queryParams DeleteFolderByIdQueryParams
    • Query parameters of deleteFolderById method
  • headers DeleteFolderByIdHeaders
    • Headers of deleteFolderById method

Returns

This function returns a value of type void.

Returns an empty response when the folder is successfully deleted or moved to the trash.

List items in folder

Retrieves a page of items in a folder. These items can be files, folders, and web links.

To request more information about the folder itself, like its size, use the Get a folder endpoint instead.

This operation is performed by calling function getFolderItems.

See the endpoint docs at API Reference.

client.getFolders().getFolderItems(folderOrigin.getId())

Arguments

  • folderId String
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • queryParams GetFolderItemsQueryParams
    • Query parameters of getFolderItems method
  • headers GetFolderItemsHeaders
    • Headers of getFolderItems method

Returns

This function returns a value of type Items.

Returns a collection of files, folders, and web links contained in a folder.

Create folder

Creates a new empty folder within the specified parent folder.

This operation is performed by calling function createFolder.

See the endpoint docs at API Reference.

client.getFolders().createFolder(new CreateFolderRequestBody(newFolderName, new CreateFolderRequestBodyParentField("0")))

Arguments

  • requestBody CreateFolderRequestBody
    • Request body of createFolder method
  • queryParams CreateFolderQueryParams
    • Query parameters of createFolder method
  • headers CreateFolderHeaders
    • Headers of createFolder method

Returns

This function returns a value of type FolderFull.

Returns a folder object.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

Copy folder

Creates a copy of a folder within a destination folder.

The original folder will not be changed.

This operation is performed by calling function copyFolder.

See the endpoint docs at API Reference.

client.getFolders().copyFolder(folderOrigin.getId(), new CopyFolderRequestBody.CopyFolderRequestBodyBuilder(new CopyFolderRequestBodyParentField("0")).name(copiedFolderName).build())

Arguments

  • folderId String
    • The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder with the ID 0 can not be copied. Example: "0"
  • requestBody CopyFolderRequestBody
    • Request body of copyFolder method
  • queryParams CopyFolderQueryParams
    • Query parameters of copyFolder method
  • headers CopyFolderHeaders
    • Headers of copyFolder method

Returns

This function returns a value of type FolderFull.

Returns a new folder object representing the copied folder.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.