|
User
|
changePrimaryLogin(String userId, String login)
Used to convert one of the user’s confirmed email aliases into the user’s primary login.
|
|
Comment
|
commentDiscussion(String discussionId, String message)
Used to add a comment to a discussion.
|
|
Comment
|
commentFile(String fileId, String message)
Used to add a comment by the user to a specific file
|
|
File
|
copyFile(String targetFolderId, String fileId)
Used to create a copy of a file in another folder.
|
|
Folder
|
copyFolder(String targetFolderId, String folderId)
Used to create a shared link for this particular folder
|
|
Collaboration
|
createCollaboration(Collaboration collaboration)
Used to add a collaboration for a single user to a folder.
|
|
Discussion
|
createDiscussion(Discussion discussion)
Used to create the metadata for a new discussion for a particular folder.
|
|
EmailAlias
|
createEmailAlias(String userId, String email)
Adds a new email alias to the given user’s account.
|
|
Folder
|
createFolder(String parentId, String folderName)
Creates a new folder and returns a folder object with all its associated information
|
|
User
|
createUser(User user)
Used to provision a new user in an enterprise.
|
|
void
|
deleteCollaboration(String collaborationId)
Used to delete a single collaboration.
|
|
void
|
deleteComment(String commentId)
Delets a comment.
|
|
void
|
deleteEmailAlias(String userId, String emailAliasId)
Removes an email alias from a user.
|
|
void
|
deleteFile(String fileId, String etag)
Discards a file to the trash.
|
|
void
|
deleteFolder(String folderId, Boolean recursive)
Deletes a folder
|
|
void
|
deleteUser(String userId, Boolean notify, Boolean force)
Deletes a user in an enterprise account.
|
|
InputStream
|
download(String fileId, String version)
Downloads a file
|
|
String
|
getAccessToken()
|
|
String
|
getBaseUrl()
|
|
String
|
getClientId()
|
|
String
|
getClientSecret()
|
|
Collaboration
|
getCollaboration(String collaborationId)
Used to get information about a single collaboration.
|
|
Comment
|
getComment(String commentId)
Used to retrieve the message and metadata about a specific comment.
|
|
Discussion
|
getDiscussion(String discussionId)
Used to retrieve the metadata about a specific discussion.
|
|
GetCommentsResponse
|
getDiscussionComments(String discussionId)
Used to retrieve all comments for a given discussion.
|
|
GetEmailAliasResponse
|
getEmailAliases(String userId)
Retrieves all email aliases for this user.
|
|
GetEventsResponse
|
getEnterpriseEvents(String createdAfter, String createdBefore, List<String> eventTypes, Long limit, Long offset)
Retrieves events for all users in an enterprise.
|
|
GetEventsResponse
|
getEvents(String streamPosition, StreamType streamType, Long limit)
Use this to get events for a given user.
|
|
LongPollingServer
|
getEventsLongPollingServer()
Requests access to a long polling server that
notifies about events in real time.
|
|
GetCommentsResponse
|
getFileComments(String fileId)
Retrieves the comments on a particular file, if any exist.
|
|
File
|
getFileMetadata(String fileId)
Used to retrieve the metadata about a file.
|
|
InputStream
|
getFileThumbnail(String fileId, ThumbnailSize minSize, ThumbnailSize maxSize)
Retrieves a thumbnail, or smaller image representation, of this file.
|
|
Folder
|
getFolder(String folderId)
Retrieves information about a given folder.
|
|
Folder
|
getFolderByPath(String resourcePath)
Returns the folder information for a given path
|
|
Entries
|
getFolderDiscussions(String folderId)
Retrieves the discussions on a particular folder, if any exist.
|
|
Item
|
getFolderItem(String folderId, String resourceName)
Traverses a given folder looking for a resource (file or folder) of a given name.
|
|
GetItemsResponse
|
getFolderItems(String folderId, Long limit, Long offset)
Retrieves the files and/or folders contained within this folder without any other metadata about the folder in the mini format is returned for each item by default.
|
|
Item
|
getItemByPath(String resourcePath)
Returns the item information for a given path.
|
|
String
|
getOAuthTokenAccessIdentifier()
|
|
GetCollaborationsResponse
|
getPendingCollaborations()
Used to retrieve all pending collaboration invites for this user.
|
|
File
|
getTrashedFile(String fileId)
Retrieves the metadata of a trashed file
|
|
Folder
|
getTrashedFolder(String folderId)
Retrieves a folder that has been moved to the trash.
|
|
GetItemsResponse
|
getTrashedItems(Long limit, Long offset)
Get the folders in the Trash.
|
|
String
|
getUploadUrl()
|
|
boolean
|
getUseGzip()
|
|
User
|
getUser()
Retrieves information about the user who is currently logged in
i.e.
|
|
GetUsersResponse
|
getUsers(String filterTerm, Long limit, Long offset)
Returns a list of all users for the Enterprise
|
|
FileVersionResponse
|
getVersionsMetadata(String fileId)
If there are previous versions of this file, this method can be used to retrieve metadata about the older versions.
|
|
void
|
init()
This method initiaes the box client and the auth callback.
|
|
synchronized
StopSourceCallback
|
listenEvents(SourceCallback callback)
Message source that subscribes to the events long polling server and will trigger a new message each time an event is generated.
|
|
Folder
|
moveFolderToUser(User targetUser, String folderId, Boolean notify)
Moves all of the content from within one user’s folder into a new folder in another user’s account.
|
|
void
|
permDeleteFile(String fileId)
Permanently deletes an item that is in the trash.
|
|
void
|
permDeleteFolder(String folderId)
Permanently deletes an item that is in the trash.
|
|
void
|
postAuth()
|
|
File
|
restoreTrashedFile(String fileId, RestoreTrashedItemRequest request)
Restores a file that has been moved to the trash.
|
|
Folder
|
restoreTrashedFolder(String folderId, RestoreTrashedItemRequest request)
Restores an item that has been moved to the trash.
|
|
SearchResponse
|
search(String query, Long limit, Long offset)
The search endpoint provides a simple way of finding items that are accessible in a given user’s Box account.
|
|
void
|
setAccessToken(String accessToken)
|
|
void
|
setBaseUrl(String baseUrl)
|
|
void
|
setClientId(String clientId)
|
|
void
|
setClientSecret(String clientSecret)
|
|
void
|
setUploadUrl(String uploadUrl)
|
|
void
|
setUseGzip(boolean useGzip)
|
|
File
|
shareFile(String fileId, SharedLink sharedLink)
Used to create a shared link for this particular file.
|
|
Folder
|
shareFolder(String folderId, SharedLink sharedLink)
Used to create a shared link for this particular folder
|
|
File
|
unshareFile(String fileId)
Deletes the shared link associated to a file
|
|
Folder
|
unshareFolder(String folderId)
Deletes the shared link associated to a folder
|
|
Collaboration
|
updateCollaboration(Collaboration collaboration, String collaborationId)
Used to update an existing collaboration.
|
|
Comment
|
updateComment(String commentId, String newMessage)
Used to update the message of the comment.
|
|
Discussion
|
updateDiscussion(Discussion discussion, String discussionId)
Used to update the metadata for an existing discussion.
|
|
File
|
updateFile(String fileId, UpdateItemRequest request, String etag)
Update a file’s information.
|
|
Folder
|
updateFolder(UpdateItemRequest request, String folderId, String etag)
Used to update information about the folder.
|
|
User
|
updateUser(String userId, User user, Boolean notify)
Used to edit the settings and information about a user.
|
|
File
|
uploadNewVersionPath(String path, String fileId, String filename, String etag, String contentModifiedAt)
Uploads a new version of a file by reading the contents from a path in local storage
|
|
File
|
uploadNewVersionStream(InputStream content, String fileId, String etag, String filename, String contentModifiedAt)
Uploads a new version of a file from an input stream
|
|
File
|
uploadPath(String path, String folderId, String filename, boolean includeHash, String contentCreatedAt, String contentModifiedAt)
Receives the path of a file in local storage and uploads its content
|
|
File
|
uploadStream(String folderId, String filename, InputStream content, boolean includeHash, String contentCreatedAt, String contentModifiedAt)
Creates a new file with the contents of a java.io.InputStream.
|
Known Direct Subclasses