@ApiParams(apiName="folders",producerOnly=true,description="Provides operations to manage Box folders",apiMethods={@ApiMethod(methodName="copyFolder",description="Copy folder to destination folder while optionally giving it a new name",signatures="com.box.sdk.BoxFolder copyFolder(String folderId, String destinationFolderId, String newName)"),@ApiMethod(methodName="createFolder",description="Create a folder specified by path from parent folder with given parentFolderId, creating intermediate directories as required",signatures={"com.box.sdk.BoxFolder createFolder(String parentFolderId, String folderName)","com.box.sdk.BoxFolder createFolder(String parentFolderId, String[] path)"}),@ApiMethod(methodName="createFolderSharedLink",description="Create a shared link to folder",signatures="com.box.sdk.BoxSharedLink createFolderSharedLink(String folderId, com.box.sdk.BoxSharedLink$Access access, java.util.Date unshareDate, com.box.sdk.BoxSharedLink$Permissions permissions)"),@ApiMethod(methodName="deleteFolder",description="Delete folder",signatures="void deleteFolder(String folderId)"),@ApiMethod(methodName="getFolder",description="Return the Box folder referenced by path",signatures="com.box.sdk.BoxFolder getFolder(String[] path)"),@ApiMethod(methodName="getFolderInfo",description="Get folder information",signatures="com.box.sdk.BoxFolder$Info getFolderInfo(String folderId, String[] fields)"),@ApiMethod(methodName="getFolderItems",description="Returns a specific range of child items in folder and specifies which fields of each item to retrieve",signatures="java.util.Collection<com.box.sdk.BoxItem$Info> getFolderItems(String folderId, Long offset, Long limit, String[] fields)"),@ApiMethod(methodName="getRootFolder",description="Return the root folder of authenticated user",signatures="com.box.sdk.BoxFolder getRootFolder()"),@ApiMethod(methodName="moveFolder",description="Move folder to destination folder while optionally giving it a new name",signatures="com.box.sdk.BoxFolder moveFolder(String folderId, String destinationFolderId, String newName)"),@ApiMethod(methodName="renameFolder",description="Rename folder giving it the name newName",signatures="com.box.sdk.BoxFolder renameFolder(String folderId, String newFolderName)"),@ApiMethod(methodName="updateFolderInfo",description="Update folder information",signatures="com.box.sdk.BoxFolder updateFolderInfo(String folderId, com.box.sdk.BoxFolder$Info info)")},aliases={"getRootFolder=root","createFolder=create","copyFolder=copy","moveFolder=move","renameFolder=rename","createFolderSharedLink=link","deleteFolder=delete","getFolder=folder","getFolderInfo=info","getFolderItems=items","updateFolderInfo=updateInfo"})
@UriParams
@Configurer(extended=true)
public final class BoxFoldersManagerEndpointConfiguration
extends BoxConfiguration
BoxFoldersManager.APP_ENTERPRISE_AUTHENTICATION, APP_USER_AUTHENTICATION, RSA_SHA_256, RSA_SHA_384, RSA_SHA_512, STANDARD_AUTHENTICATION| Constructor and Description |
|---|
BoxFoldersManagerEndpointConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
com.box.sdk.BoxSharedLink.Access |
getAccess() |
String |
getDestinationFolderId() |
String[] |
getFields() |
String |
getFolderId() |
String |
getFolderName() |
com.box.sdk.BoxFolder.Info |
getInfo() |
Long |
getLimit() |
String |
getNewFolderName() |
String |
getNewName() |
Long |
getOffset() |
String |
getParentFolderId() |
String[] |
getPath() |
com.box.sdk.BoxSharedLink.Permissions |
getPermissions() |
Date |
getUnshareDate() |
void |
setAccess(com.box.sdk.BoxSharedLink.Access access) |
void |
setDestinationFolderId(String destinationFolderId) |
void |
setFields(String[] fields) |
void |
setFolderId(String folderId) |
void |
setFolderName(String folderName) |
void |
setInfo(com.box.sdk.BoxFolder.Info info) |
void |
setLimit(Long limit) |
void |
setNewFolderName(String newFolderName) |
void |
setNewName(String newName) |
void |
setOffset(Long offset) |
void |
setParentFolderId(String parentFolderId) |
void |
setPath(String[] path) |
void |
setPermissions(com.box.sdk.BoxSharedLink.Permissions permissions) |
void |
setUnshareDate(Date unshareDate) |
equals, getAccessTokenCache, getApiName, getAuthenticationType, getClientId, getClientSecret, getEncryptionAlgorithm, getEnterpriseId, getHttpParams, getMaxCacheEntries, getMethodName, getPrivateKeyFile, getPrivateKeyPassword, getPublicKeyId, getSslContextParameters, getUserId, getUserName, getUserPassword, hashCode, setAccessTokenCache, setApiName, setAuthenticationType, setClientId, setClientSecret, setEncryptionAlgorithm, setEncryptionAlgorithm, setEnterpriseId, setHttpParams, setMaxCacheEntries, setMaxCacheEntries, setMethodName, setPrivateKeyFile, setPrivateKeyPassword, setPublicKeyId, setSslContextParameters, setUserId, setUserName, setUserPasswordpublic BoxFoldersManagerEndpointConfiguration()
public com.box.sdk.BoxSharedLink.Access getAccess()
public void setAccess(com.box.sdk.BoxSharedLink.Access access)
public String getDestinationFolderId()
public void setDestinationFolderId(String destinationFolderId)
public String[] getFields()
public void setFields(String[] fields)
public String getFolderId()
public void setFolderId(String folderId)
public String getFolderName()
public void setFolderName(String folderName)
public com.box.sdk.BoxFolder.Info getInfo()
public void setInfo(com.box.sdk.BoxFolder.Info info)
public Long getLimit()
public void setLimit(Long limit)
public String getNewFolderName()
public void setNewFolderName(String newFolderName)
public String getNewName()
public void setNewName(String newName)
public Long getOffset()
public void setOffset(Long offset)
public String getParentFolderId()
public void setParentFolderId(String parentFolderId)
public String[] getPath()
public void setPath(String[] path)
public com.box.sdk.BoxSharedLink.Permissions getPermissions()
public void setPermissions(com.box.sdk.BoxSharedLink.Permissions permissions)
public Date getUnshareDate()
public void setUnshareDate(Date unshareDate)
Apache Camel