public class FoldersManager extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
FoldersManager.Builder |
| Modifier and Type | Field and Description |
|---|---|
Authentication |
auth |
NetworkSession |
networkSession |
| Modifier | Constructor and Description |
|---|---|
|
FoldersManager() |
protected |
FoldersManager(FoldersManager.Builder builder) |
| Modifier and Type | Method and Description |
|---|---|
FolderFull |
copyFolder(String folderId,
CopyFolderRequestBody requestBody)
Creates a copy of a folder within a destination folder.
|
FolderFull |
copyFolder(String folderId,
CopyFolderRequestBody requestBody,
CopyFolderHeaders headers)
Creates a copy of a folder within a destination folder.
|
FolderFull |
copyFolder(String folderId,
CopyFolderRequestBody requestBody,
CopyFolderQueryParams queryParams)
Creates a copy of a folder within a destination folder.
|
FolderFull |
copyFolder(String folderId,
CopyFolderRequestBody requestBody,
CopyFolderQueryParams queryParams,
CopyFolderHeaders headers)
Creates a copy of a folder within a destination folder.
|
FolderFull |
createFolder(CreateFolderRequestBody requestBody)
Creates a new empty folder within the specified parent folder.
|
FolderFull |
createFolder(CreateFolderRequestBody requestBody,
CreateFolderHeaders headers)
Creates a new empty folder within the specified parent folder.
|
FolderFull |
createFolder(CreateFolderRequestBody requestBody,
CreateFolderQueryParams queryParams)
Creates a new empty folder within the specified parent folder.
|
FolderFull |
createFolder(CreateFolderRequestBody requestBody,
CreateFolderQueryParams queryParams,
CreateFolderHeaders headers)
Creates a new empty folder within the specified parent folder.
|
void |
deleteFolderById(String folderId)
Deletes a folder, either permanently or by moving it to the trash.
|
void |
deleteFolderById(String folderId,
DeleteFolderByIdHeaders headers)
Deletes a folder, either permanently or by moving it to the trash.
|
void |
deleteFolderById(String folderId,
DeleteFolderByIdQueryParams queryParams)
Deletes a folder, either permanently or by moving it to the trash.
|
void |
deleteFolderById(String folderId,
DeleteFolderByIdQueryParams queryParams,
DeleteFolderByIdHeaders headers)
Deletes a folder, either permanently or by moving it to the trash.
|
Authentication |
getAuth() |
FolderFull |
getFolderById(String folderId)
Retrieves details for a folder, including the first 100 entries in the folder.
|
FolderFull |
getFolderById(String folderId,
GetFolderByIdHeaders headers)
Retrieves details for a folder, including the first 100 entries in the folder.
|
FolderFull |
getFolderById(String folderId,
GetFolderByIdQueryParams queryParams)
Retrieves details for a folder, including the first 100 entries in the folder.
|
FolderFull |
getFolderById(String folderId,
GetFolderByIdQueryParams queryParams,
GetFolderByIdHeaders headers)
Retrieves details for a folder, including the first 100 entries in the folder.
|
Items |
getFolderItems(String folderId)
Retrieves a page of items in a folder.
|
Items |
getFolderItems(String folderId,
GetFolderItemsHeaders headers)
Retrieves a page of items in a folder.
|
Items |
getFolderItems(String folderId,
GetFolderItemsQueryParams queryParams)
Retrieves a page of items in a folder.
|
Items |
getFolderItems(String folderId,
GetFolderItemsQueryParams queryParams,
GetFolderItemsHeaders headers)
Retrieves a page of items in a folder.
|
NetworkSession |
getNetworkSession() |
FolderFull |
updateFolderById(String folderId)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdHeaders headers)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdQueryParams queryParams)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdQueryParams queryParams,
UpdateFolderByIdHeaders headers)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdRequestBody requestBody)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdRequestBody requestBody,
UpdateFolderByIdHeaders headers)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdRequestBody requestBody,
UpdateFolderByIdQueryParams queryParams)
Updates a folder.
|
FolderFull |
updateFolderById(String folderId,
UpdateFolderByIdRequestBody requestBody,
UpdateFolderByIdQueryParams queryParams,
UpdateFolderByIdHeaders headers)
Updates a folder.
|
public Authentication auth
public NetworkSession networkSession
public FoldersManager()
protected FoldersManager(FoldersManager.Builder builder)
public FolderFull getFolderById(String folderId)
Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).
To fetch more items within the folder, use the [Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.
folderId - 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"
public FolderFull getFolderById(String folderId, GetFolderByIdQueryParams queryParams)
Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).
To fetch more items within the folder, use the [Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.
folderId - 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 - Query parameters of getFolderById methodpublic FolderFull getFolderById(String folderId, GetFolderByIdHeaders headers)
Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).
To fetch more items within the folder, use the [Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.
folderId - 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"
headers - Headers of getFolderById methodpublic FolderFull getFolderById(String folderId, GetFolderByIdQueryParams queryParams, GetFolderByIdHeaders headers)
Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).
To fetch more items within the folder, use the [Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.
folderId - 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 - Query parameters of getFolderById methodheaders - Headers of getFolderById methodpublic FolderFull updateFolderById(String folderId)
folderId - 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"
public FolderFull updateFolderById(String folderId, UpdateFolderByIdRequestBody requestBody)
folderId - 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 - Request body of updateFolderById methodpublic FolderFull updateFolderById(String folderId, UpdateFolderByIdQueryParams queryParams)
folderId - 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 - Query parameters of updateFolderById methodpublic FolderFull updateFolderById(String folderId, UpdateFolderByIdRequestBody requestBody, UpdateFolderByIdQueryParams queryParams)
folderId - 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 - Request body of updateFolderById methodqueryParams - Query parameters of updateFolderById methodpublic FolderFull updateFolderById(String folderId, UpdateFolderByIdHeaders headers)
folderId - 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"
headers - Headers of updateFolderById methodpublic FolderFull updateFolderById(String folderId, UpdateFolderByIdRequestBody requestBody, UpdateFolderByIdHeaders headers)
folderId - 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 - Request body of updateFolderById methodheaders - Headers of updateFolderById methodpublic FolderFull updateFolderById(String folderId, UpdateFolderByIdQueryParams queryParams, UpdateFolderByIdHeaders headers)
folderId - 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 - Query parameters of updateFolderById methodheaders - Headers of updateFolderById methodpublic FolderFull updateFolderById(String folderId, UpdateFolderByIdRequestBody requestBody, UpdateFolderByIdQueryParams queryParams, UpdateFolderByIdHeaders headers)
folderId - 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 - Request body of updateFolderById methodqueryParams - Query parameters of updateFolderById methodheaders - Headers of updateFolderById methodpublic void deleteFolderById(String folderId)
folderId - 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"
public void deleteFolderById(String folderId, DeleteFolderByIdQueryParams queryParams)
folderId - 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 - Query parameters of deleteFolderById methodpublic void deleteFolderById(String folderId, DeleteFolderByIdHeaders headers)
folderId - 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"
headers - Headers of deleteFolderById methodpublic void deleteFolderById(String folderId, DeleteFolderByIdQueryParams queryParams, DeleteFolderByIdHeaders headers)
folderId - 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 - Query parameters of deleteFolderById methodheaders - Headers of deleteFolderById methodpublic Items getFolderItems(String folderId)
To request more information about the folder itself, like its size, use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
folderId - 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"
public Items getFolderItems(String folderId, GetFolderItemsQueryParams queryParams)
To request more information about the folder itself, like its size, use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
folderId - 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 - Query parameters of getFolderItems methodpublic Items getFolderItems(String folderId, GetFolderItemsHeaders headers)
To request more information about the folder itself, like its size, use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
folderId - 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"
headers - Headers of getFolderItems methodpublic Items getFolderItems(String folderId, GetFolderItemsQueryParams queryParams, GetFolderItemsHeaders headers)
To request more information about the folder itself, like its size, use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.
folderId - 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 - Query parameters of getFolderItems methodheaders - Headers of getFolderItems methodpublic FolderFull createFolder(CreateFolderRequestBody requestBody)
requestBody - Request body of createFolder methodpublic FolderFull createFolder(CreateFolderRequestBody requestBody, CreateFolderQueryParams queryParams)
requestBody - Request body of createFolder methodqueryParams - Query parameters of createFolder methodpublic FolderFull createFolder(CreateFolderRequestBody requestBody, CreateFolderHeaders headers)
requestBody - Request body of createFolder methodheaders - Headers of createFolder methodpublic FolderFull createFolder(CreateFolderRequestBody requestBody, CreateFolderQueryParams queryParams, CreateFolderHeaders headers)
requestBody - Request body of createFolder methodqueryParams - Query parameters of createFolder methodheaders - Headers of createFolder methodpublic FolderFull copyFolder(String folderId, CopyFolderRequestBody requestBody)
The original folder will not be changed.
folderId - 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 - Request body of copyFolder methodpublic FolderFull copyFolder(String folderId, CopyFolderRequestBody requestBody, CopyFolderQueryParams queryParams)
The original folder will not be changed.
folderId - 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 - Request body of copyFolder methodqueryParams - Query parameters of copyFolder methodpublic FolderFull copyFolder(String folderId, CopyFolderRequestBody requestBody, CopyFolderHeaders headers)
The original folder will not be changed.
folderId - 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 - Request body of copyFolder methodheaders - Headers of copyFolder methodpublic FolderFull copyFolder(String folderId, CopyFolderRequestBody requestBody, CopyFolderQueryParams queryParams, CopyFolderHeaders headers)
The original folder will not be changed.
folderId - 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 - Request body of copyFolder methodqueryParams - Query parameters of copyFolder methodheaders - Headers of copyFolder methodpublic Authentication getAuth()
public NetworkSession getNetworkSession()