org.mule.modules.box

Class BoxConnector

java.lang.Object

org.mule.modules.box.BoxConnector

Direct Known Subclasses:

org.mule.modules.box.generated.adapters.BoxConnectorCapabilitiesAdapter

@RequiresEnterpriseLicense(allowEval=true)
@Connector(name="box",
           friendlyName="Box",
           minMuleVersion="3.6")
@ReconnectOn(exceptions=org.mule.api.ConnectionException.class)
@MetaDataScope(value=EntityMetaData.class)
public class BoxConnector
extends Object

Box Connector.

Author:

MuleSoft Inc.

Constructor Summary

Constructors

Constructor and Description
BoxConnector()

Method Summary

Methods

Modifier and Type	Method and Description
Comment	addCommentToFile(String fileId, String message) Used to add a comment by the user to a specific file.
Membership	addGroupMembership(String groupId, String userId, MembershipRole membershipRole) Adds a member to a Group.
Assignment	addTaskAssignment(String taskId, String assignTo) Used to assign a task to a single user.
Task	addTaskToFile(String fileId, String message, Date dueAt) Used to create a single task for single user on a single file.
File	copyFile(String fileId, String folderId, String newName) Creates a copy of a file in another folder and rename it.
Folder	copyFolder(String folderId, String parentFolderId, String newName) Used to create a copy of a folder in another folder.
User	createAppUser(String username) Used to provision a new user in an enterprise.
Collaboration	createCollaboration(String folderId, String collaboratorId, CollaborationRole collaborationRole) Adds a collaboration for a single user or a single group to a folder.
Folder	createFolder(String folderName, String parentId) Used to create a new empty folder.
Group	createGroup(String groupName) Used to create a group.
SharedLink	createSharedLinkFile(String fileId, SharedLinkAccess access, Date unsharedAt, SharedLinkPermissions permissions) Createe a shared link for this particular file.
SharedLink	createSharedLinkFolder(String folderId, SharedLinkAccess access, Date unsharedAt, SharedLinkPermissions permissions) Used to create a shared link for the particular folder.
void	deleteCollaboration(String collaborationId) Used to delete a single collaboration.
void	deleteComment(String commentId) Permanently deletes a comment.
void	deleteFile(String fileId) Discards a file to the trash.
void	deleteFolder(String folderId, boolean recursive) Used to delete a folder.
void	deleteGroup(String groupId) Permanently deletes a specific group.
void	deleteGroupMembership(String groupMemberShipId) Deletes a specific group membership.
void	deleteOldFileVersion(String fileId, String versionId) Discards a specific file version to the trash.
void	deleteTask(String taskId) Permanently deletes a specific task.
void	deleteTaskAssignment(String assignmentId) Deletes a specific task assignment.
void	deleteUser(String userId, boolean notifyUser, boolean force) Deletes a user in an enterprise account.
InputStream	downloadFile(String fileId) Retrieves the actual data of the file.
InputStream	downloadFileVersion(String fileId, String versionId) Downloads previous versions of a file.
List<Group>	getAllGroups() Retrieves all of the groups that the current user is a member of.
AssignmentClient	getAssignmentClient()
Collaboration	getCollaborationInfo(String collaborationId) Retrieves information about a single collaboration.
Comment	getCommentInfo(String commentId) Used to retrieve the message and metadata about a specific comment.
AbstractConfig	getConfig()
User	getCurrentUser(List<String> fields) Retrieves information about the user who is currently logged in i.e.
String	getDownloadURL(String fileId) Retrieves the download URL of the file.
List<User>	getEnterpriseUsers() Returns a list of all users for the Enterprise along with their user_id, public_name, and login.
List<Comment>	getFileComments(String fileId) Gets a list of any comments on this file.
File	getFileInfo(String fileId, List<String> fields) Retrieves the metadata about a file.
URL	getFilePreviewLink(String fileId) Retrieves an expiring URL for creating an embedded preview session.
List<Task>	getFileTasks(String fileId) Retrieves all of the tasks for given file.
List<FileVersion>	getFileVersions(String fileId) Retrieved any previous versions of the specified file.
List<Collaboration>	getFolderCollaborations(String folderId) Use this to get a list of all the collaborations on a folder i.e.
Folder	getFolderInfo(String folderId) Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it.
List<Item>	getFolderItems(String folderId, List<String> fields) Retrieves the files and/or folders contained within this folder without any other metadata about the folder.
GroupClient	getGroupClient()
Group	getGroupInfo(String groupId) Retrieves information about a group.
Membership	getGroupMembership(String groupMemberShipId) Fetches a specific group membership entry.
List<Membership>	getGroupMemberships(String groupId) Retrieves all of the members for a given group if the requesting user has access
MembershipClient	getMembershipClient()
List<Collaboration>	getPendingCollaborations() Used to retrieve all pending collaboration invites for this user.
Assignment	getTaskAssignmentInfo(String assignmentId) Fetches a specific task assignment.
List<Assignment>	getTaskAssignments(String taskId) Retrieves all of the assignments for a given task.
TaskClient	getTaskClient()
Task	getTaskInfo(String taskId) Fetches a specific task.
InputStream	getThumbnail(String fileId, ThumbnailType thumbnailType, Integer minWidth, Integer minHeight, Integer maxWidth, Integer maxHeight) Retrieves a thumbnail, or smaller image representation, of this file.
File	getTrashedFile(String fileId, List<String> fields) Retrieves an item that has been moved to the trash.
Folder	getTrashedFolder(String folderId, List<String> fields) Retrieves a folder that has been moved to the trash.
List<Item>	getTrashedItems(List<String> fields) Retrieves the files and/or folders that have been moved to the trash.
UserClient	getUserClient()
List<Membership>	getUserGroupMemberships(String userId) Retrieves all of the group memberships for a given user.
User	getUserInfo(String userId, List<String> fields) Retrieves information about a user in the enterprise.
Folder	moveFolderToUser(String userId, String targetUserId) Moves all of the owned content from within one user’s folder into a new folder in another user’s account.
void	permanentlyDeleteFile(String fileId) Permanently deletes an item that is in the trash.
void	permanentlyDeleteFolder(String folderId) Permanently deletes an item that is in the trash.
void	promoteFileVersion(String fileId, String versionId) For users with premium accounts, If there are previous versions of this file, this method can be used to promote one of the older versions to the top of the stack.
Comment	replyToComment(String commentId, String message) Replies to this comment with another message.
File	restoreFile(String fileId, String newName, String newParentId) Restores an item that has been moved to the trash.
Folder	restoreFolder(String folderId, String newName, String newParentId) Restores an item that has been moved to the trash.
List<Item>	search(String query, String parentFolderId) The search endpoint provides a simple way of finding items that are accessible in a given user’s Box account.
void	setConfig(AbstractConfig config)
Collaboration	updateCollaboration(String collaborationId, CollaborationInput input) Used to edit an existing collaboration.
Comment	updateComment(String commentId, String message) Used to update the message of the comment.
File	updateFileInfo(String fileId, FileInput fileInfo) Used to update individual or multiple fields in the file object, including renaming the file, changing its description, and creating a shared link for the file.
Folder	updateFolder(String folderId, FolderInput input) Used to update information about the folder.
Membership	updateGroupMembership(String groupMemberShipId, MembershipInput groupMembership) Updates a group membership.
Assignment	updateTaskAssignmentInfo(String assignmentId, AssignmentInput taskAssignmentInfo) Updates a task assignment.
Task	updateTaskInfo(String taskId, TaskInput taskInfo) Updates a specific task.
User	updateUserInfo(String userId, UserInput input) Used to edit the settings and information about a user.
File	uploadFile(String fileName, String folderId, InputStream fileContent) Uploads a new file to the specified folder.
File	uploadNewVersion(String fileId, InputStream fileContent, Date modifiedAt) Uploading a new file version is performed in the same way as uploading a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxConnector

public BoxConnector()

Method Detail

getFolderInfo

@OAuthProtected
@Processor(friendlyName="Folders | Get Folder\'s Info")
public Folder getFolderInfo(@Default(value="#[payload]")
                                            String folderId)

Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it. The root folder of a Box account is always represented by the id “0”.

Parameters:

folderId - The ID of the folder to be retrieved.

Returns:

A full folder object is returned, including the most current information available about it. An error is thrown if the folder does not exist or if the user does not have access to it.

Api.doc:

https://box-content.readme.io/reference#folder-object

getFolderItems

@OAuthProtected
@Processor(friendlyName="Folders | Get Folder\'s Items")
public List<Item> getFolderItems(@Default(value="0")
                                                 String folderId,
                                                 @RefOnly@Optional
                                                 List<String> fields)

Retrieves the files and/or folders contained within this folder without any other metadata about the folder. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at.

Parameters:

folderId - The ID of the folder you want to inspect. If not provided, the root folder is assumed.

fields - Attribute(s) to include in the response.

Returns:

A collection of items contained in the folder is returned. An error is thrown if the folder does not exist, or if any of the parameters are invalid.

Api.doc:

https://box-content.readme.io/reference#get-a-folders-items

createFolder

@OAuthProtected
@Processor(friendlyName="Folders | Create Folder")
public Folder createFolder(@Default(value="#[payload]")
                                           String folderName,
                                           @Default(value="0")
                                           String parentId)

Used to create a new empty folder. The new folder will be created inside of the specified parent folder.

Parameters:

folderName - The desired name for the folder.

parentId - The ID of the parent folder. Default value is "0", which represents the root folder.

Returns:

The the new folder.

Api.doc:

https://box-content.readme.io/reference#create-a-new-folder

updateFolder

@OAuthProtected
@Processor(friendlyName="Folders | Update Folder")
public Folder updateFolder(String folderId,
                                           @RefOnly@Default(value="#[payload]")
                                           FolderInput input)

Used to update information about the folder. To move a folder, update the ID of its parent. To enable an email address that can be used to upload files to this folder, update the folder_upload_email attribute. An optional If-Match header can be included to ensure that client only updates the folder if it knows about the latest version.

Parameters:

folderId - The id of the folder to be modified.

input - An instance of FolderInput with the attributes you want to change.

Returns:

The updated folder.

Api.doc:

https://box-content.readme.io/reference#update-information-about-a-folder

deleteFolder

@OAuthProtected
@Processor(friendlyName="Folders | Delete Folder")
public void deleteFolder(@Default(value="#[payload]")
                                         String folderId,
                                         @Default(value="true")
                                         boolean recursive)

Used to delete a folder. A recursive parameter must be included in order to delete folders that have items inside of them.

Parameters:

folderId - The ID of the folder to be deleted.

recursive - Whether to delete this folder if it has items inside of it.

Api.doc:

https://box-content.readme.io/reference#delete-a-folder

copyFolder

@OAuthProtected
@Processor(friendlyName="Folders | Copy Folder")
public Folder copyFolder(@Default(value="#[payload]")
                                         String folderId,
                                         @FriendlyName(value="Parent")@Default(value="0")
                                         String parentFolderId,
                                         @FriendlyName(value="Name")@Optional
                                         String newName)

Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

Parameters:

folderId - The ID of the destination folder.

parentFolderId - The ID of the parent folder that will hold the copy. If not provided then the root will be used.

newName - An optional new name for the folder.

Returns:

The new copied folder. Errors can be thrown if the destination folder is invalid or if a file-name collision occurs. A 409 will be returned if the intended destination folder is the same, as this will cause a name collision.

Api.doc:

https://box-content.readme.io/reference#copy-a-folder

createSharedLinkFolder

@OAuthProtected
@Processor(friendlyName="Folders | Create Shared Link")
public SharedLink createSharedLinkFolder(@Default(value="#[payload]")
                                                         String folderId,
                                                         @RefOnly@Default(value="DEFAULT")
                                                         SharedLinkAccess access,
                                                         @Optional
                                                         Date unsharedAt,
                                                         @RefOnly
                                                         SharedLinkPermissions permissions)

Used to create a shared link for the particular folder.

Parameters:

folderId - The ID of the folder to whom a shared link to be created.

access - The level of access required for this shared link. Can be open, company, collaborators, or null to get default share level.

unsharedAt - The day that this link should be disabled at. RFC-3339 valid date-timestamps are rounded off to the given day. This field can only be set if the user has been granted permission (yes, it’s complicated) and is not a free user.

permissions - The set of permissions that apply to this link.

Returns:

A full folder object containing the updated shared link is returned if the ID is valid and if the update is successful.

Api.doc:

https://box-content.readme.io/reference#create-a-shared-link-for-a-folder

getFolderCollaborations

@OAuthProtected
@Processor(friendlyName="Folders | Get Folder Collaborations")
public List<Collaboration> getFolderCollaborations(@Default(value="#[payload]")
                                                                   String folderId)

Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

Parameters:

folderId - The ID of the folder.

Returns:

A collection of collaboration objects are returned. If there are no collaborations on this folder, an empty collection will be returned.

Api.doc:

https://box-content.readme.io/reference#view-a-folders-collaborations

getTrashedItems

@OAuthProtected
@Processor(friendlyName="Folders | Get Trashed Items")
public List<Item> getTrashedItems(@RefOnly@Default(value="#[payload]")
                                                  List<String> fields)

Retrieves the files and/or folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in separated by commas e.g. fields=name,created_at. Paginated results can be retrieved using the limit and offset parameters.

Parameters:

fields - Attribute(s) to include in the response

Returns:

The List of Items.

Api.doc:

https://box-content.readme.io/reference#get-the-items-in-the-trash

getTrashedFolder

@OAuthProtected
@Processor(friendlyName="Folders | Get Trashed Folder")
public Folder getTrashedFolder(@Default(value="#[payload]")
                                               String folderId,
                                               @RefOnly@Optional
                                               List<String> fields)

Retrieves a folder that has been moved to the trash.

Parameters:

folderId - The ID of the folder.

fields - Attribute(s) to include in the response.

Returns:

The full item will be returned, including information about when the it was moved to the trash. A 404 will be returned if the item is not in the trash.

Api.doc:

https://box-content.readme.io/reference#get-a-trashed-folder

permanentlyDeleteFolder

@OAuthProtected
@Processor(friendlyName="Folders | Permanently Delete")
public void permanentlyDeleteFolder(@Default(value="#[payload]")
                                                    String folderId)

Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.

Parameters:

folderId - The ID of the folder to be permanently deleted.

Api.doc:

https://box-content.readme.io/reference#permanently-delete-a-trashed-folder

restoreFolder

@OAuthProtected
@Processor(friendlyName="Folders | Restore Folder")
public Folder restoreFolder(@Default(value="#[payload]")
                                            String folderId,
                                            @FriendlyName(value="Name")@Optional
                                            String newName,
                                            @FriendlyName(value="Parent")@Optional
                                            String newParentId)

Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.

Parameters:

folderId - The ID of the trashed folder being restored.

newName - The new name for this item.

newParentId - The new parent folder for this item.

Returns:

The restored folder. By default it is restored to the parent folder it was in before it was trashed.

Api.doc:

https://box-content.readme.io/reference#restore-a-trashed-folder

getFileInfo

@OAuthProtected
@Processor(friendlyName="Files | Get File\'s Info")
public File getFileInfo(@Default(value="#[payload]")
                                        String fileId,
                                        @RefOnly@Optional
                                        List<String> fields)

Retrieves the metadata about a file.

Parameters:

fileId - The ID of the file.

fields - Attribute(s) to include in the response.

Returns:

A full file object is returned if the ID is valid and if the user has access to the file.

Api.doc:

https://box-content.readme.io/reference#files

updateFileInfo

@OAuthProtected
@Processor(friendlyName="Files | Update File Info")
public File updateFileInfo(@Default(value="#[payload]")
                                           String fileId,
                                           @RefOnly
                                           FileInput fileInfo)

Used to update individual or multiple fields in the file object, including renaming the file, changing its description, and creating a shared link for the file. To move a file, change the ID of its parent folder.

Parameters:

fileId - The ID of the file.

fileInfo - The updated file info object.

Returns:

The updated file.

Api.doc:

https://box-content.readme.io/reference#update-a-files-information

downloadFile

@OAuthProtected
@Processor(friendlyName="Files | Download File")
public InputStream downloadFile(@Default(value="#[payload]")
                                                String fileId)

Retrieves the actual data of the file.

Parameters:

fileId - The ID of the file.

Returns:

An InputStream with the downloaded file.

Api.doc:

https://box-content.readme.io/reference#download-a-file

getDownloadURL

@OAuthProtected
@Processor(friendlyName="Files | Get download URL")
public String getDownloadURL(@Default(value="#[payload]")
                                             String fileId)

Retrieves the download URL of the file.

Parameters:

fileId - The ID of the file.

Returns:

The URL to download the file.

uploadFile

@OAuthProtected
@Processor(friendlyName="Files | Upload File")
public File uploadFile(String fileName,
                                       @Default(value="0")
                                       String folderId,
                                       @RefOnly@Default(value="#[payload]")
                                       InputStream fileContent)

Uploads a new file to the specified folder.

Parameters:

fileName - The name to give the uploaded file.

folderId - The ID of the folder.

fileContent - A stream containing the contents of the file to upload.

Returns:

The uploaded file.

Api.doc:

https://box-content.readme.io/reference#upload-a-file

deleteFile

@OAuthProtected
@Processor(friendlyName="Files | Delete File")
public void deleteFile(@Default(value="[#payload]")
                                       String fileId)

Discards a file to the trash.

Parameters:

fileId - The ID of the file.

Api.doc:

https://box-content.readme.io/reference#delete-a-file

uploadNewVersion

@OAuthProtected
@Processor(friendlyName="Files | Update File")
public File uploadNewVersion(String fileId,
                                             @RefOnly@Default(value="[#payload]")
                                             InputStream fileContent,
                                             @Optional
                                             Date modifiedAt)

Uploading a new file version is performed in the same way as uploading a file. This method uploads a new version of an existing file in a user’s account.

Parameters:

fileId - The ID of the file.

fileContent - A stream containing the new file contents.

modifiedAt - The date that the new version was modified.

Returns:

The updated file.

Api.doc:

https://box-content.readme.io/reference#upload-a-new-version-of-a-file

getFileVersions

@OAuthProtected
@Processor(friendlyName="Files | View Versions")
public List<FileVersion> getFileVersions(String fileId)

Retrieved any previous versions of the specified file. Note that versions are only tracked for users with premium accounts.

Parameters:

fileId - The ID of the file.

Returns:

An array of version objects are returned. If there are no previous versions of this file, then an empty array will be returned.

Api.doc:

https://box-content.readme.io/reference#view-versions-of-a-file

downloadFileVersion

@OAuthProtected
@Processor(friendlyName="Files | Download Version")
public InputStream downloadFileVersion(@Default(value="#[payload]")
                                                       String fileId,
                                                       String versionId)

Downloads previous versions of a file. Only for users with premium accounts.

Parameters:

fileId - The ID of the file.

versionId - The version ID of specified version of the file.

Returns:

An InputStream containing the file contents.

Api.doc:

https://box-content.readme.io/reference#download-an-old-version-of-a-file

promoteFileVersion

@OAuthProtected
@Processor(friendlyName="Files | Promote Version")
public void promoteFileVersion(@Default(value="#[payload]")
                                               String fileId,
                                               String versionId)

For users with premium accounts, If there are previous versions of this file, this method can be used to promote one of the older versions to the top of the stack. This actually mints a copy of the old version and puts it on the top of the versions stack.

Parameters:

fileId - The ID of the file.

versionId - The version ID of specified version of the file.

Api.doc:

https://box-content.readme.io/reference#promote-an-old-version-of-a-file

deleteOldFileVersion

@OAuthProtected
@Processor(friendlyName="Files | Delete Old Version")
public void deleteOldFileVersion(@Default(value="#[payload]")
                                                 String fileId,
                                                 String versionId)

Discards a specific file version to the trash.

Parameters:

fileId - The ID of the file.

versionId - The version ID of specified version of the file.

Api.doc:

https://box-content.readme.io/reference#delete-an-old-version-of-a-file

copyFile

@OAuthProtected
@Processor(friendlyName="Files | Copy And Rename File")
public File copyFile(@Default(value="#[payload]")
                                     String fileId,
                                     @Default(value="0")
                                     String folderId,
                                     @FriendlyName(value="Name")
                                     String newName)

Creates a copy of a file in another folder and rename it. The original version of the file will not be altered.

Parameters:

fileId - The ID of the file you want to copy.

folderId - The folder ID representing the new location of the file.

newName - An optional new name for the file.

Returns:

The new file. Errors can be thrown if the destination folder is invalid or if a file-name collision occurs.

Api.doc:

https://box-content.readme.io/reference#copy-a-file

getThumbnail

@OAuthProtected
@Processor(friendlyName="Files | Get Thumbnail")
public InputStream getThumbnail(@Default(value="#[payload]")
                                                String fileId,
                                                @RefOnly@Default(value="PNG")
                                                ThumbnailType thumbnailType,
                                                Integer minWidth,
                                                Integer minHeight,
                                                Integer maxWidth,
                                                Integer maxHeight)

Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32, 64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg format.

Parameters:

fileId - The ID of the file

thumbnailType - Either PNG of JPG

minWidth - The minimum width of the thumbnail

minHeight - The minimum height of the thumbnail

maxWidth - The maximum width of the thumbnail

maxHeight - The maximum height of the thumbnail

Returns:

The byte array of the thumbnail image

Api.doc:

https://box-content.readme.io/reference#get-a-thumbnail-for-a-file

getFilePreviewLink

@OAuthProtected
@Processor(friendlyName="Files | Get Embed Link")
public URL getFilePreviewLink(@Default(value="#[payload]")
                                              String fileId)

Retrieves an expiring URL for creating an embedded preview session. The URL will expire after 60 seconds and the preview session will expire after 60 minutes.

Parameters:

fileId - The ID of the file.

Returns:

The expiring preview link.

Api.doc:

https://box-content.readme.io/reference#get-embed-link

createSharedLinkFile

@OAuthProtected
@Processor(friendlyName="Files | Create Shared Link")
public SharedLink createSharedLinkFile(@Default(value="#[payload]")
                                                       String fileId,
                                                       @RefOnly@Default(value="DEFAULT")
                                                       SharedLinkAccess access,
                                                       @Optional
                                                       Date unsharedAt,
                                                       @RefOnly
                                                       SharedLinkPermissions permissions)

Createe a shared link for this particular file.

Parameters:

fileId - The ID of the file

access - The level of access required for this shared link. Can be open, company, collaborators, or null to get default share level.

unsharedAt - The day that this link should be disabled at. Timestamps are rounded off to the given day. This field can only be set if the user is not a free user.

permissions - The set of permissions that apply to this link

Returns:

A full file object containing the updated shared link is returned if the ID is valid and if the update is successful.

Api.doc:

https://box-content.readme.io/reference#create-a-shared-link-for-a-file

getTrashedFile

@OAuthProtected
@Processor(friendlyName="Files | Get Trashed File")
public File getTrashedFile(@Default(value="#[payload]")
                                           String fileId,
                                           @RefOnly@Optional
                                           List<String> fields)

Retrieves an item that has been moved to the trash.

Parameters:

fileId - The ID of the file.

fields - Attribute(s) to include in the response.

Returns:

The full item will be returned, including information about when the it was moved to the trash.

Api.doc:

https://box-content.readme.io/reference#get-a-trashed-file

permanentlyDeleteFile

@OAuthProtected
@Processor(friendlyName="Files | Permanently Delete")
public void permanentlyDeleteFile(@Default(value="#[payload]")
                                                  String fileId)

Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.

Parameters:

fileId - The ID of the file to be permanently deleted.

Api.doc:

https://box-content.readme.io/reference#permanently-delete-a-trashed-file

restoreFile

@OAuthProtected
@Processor(friendlyName="Files | Restore Item")
public File restoreFile(@Default(value="#[payload]")
                                        String fileId,
                                        @FriendlyName(value="Name")@Optional
                                        String newName,
                                        @FriendlyName(value="Parent")@Optional
                                        String newParentId)

Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.

Parameters:

fileId - The ID of the trashed file being restored.

newName - The new name for this item.

newParentId - The new parent folder for this item.

Returns:

The returned file. By default it is restored to the parent folder it was in before it was trashed.

Api.doc:

https://box-content.readme.io/reference#restore-a-trashed-item

getFileComments

@OAuthProtected
@Processor(friendlyName="Files | View Comments")
public List<Comment> getFileComments(@Default(value="#[payload]")
                                                     String fileId)

Gets a list of any comments on this file.

Parameters:

fileId - The ID of the file.

Returns:

A collection of comment objects are returned. If there are no comments on the file, an empty comments array is returned.

Api.doc:

https://box-content.readme.io/reference#view-the-comments-on-a-file

getFileTasks

@OAuthProtected
@Processor(friendlyName="Files | Get File\'s Tasks")
public List<Task> getFileTasks(@Default(value="#[payload]")
                                               String fileId)

Retrieves all of the tasks for given file.

Parameters:

fileId - The ID of the file.

Returns:

A collection of mini task objects is returned. If there are no tasks, an empty collection will be returned.

Api.doc:

https://box-content.readme.io/reference#get-the-tasks-for-a-file

getCommentInfo

@OAuthProtected
@Processor(friendlyName="Comments | Get Comment")
public Comment getCommentInfo(@Default(value="#[payload]")
                                              String commentId)

Used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.

Parameters:

commentId - The ID of the comment.

Returns:

A full comment object is returned is the ID is valid and if the user has access to the comment.

Api.doc:

https://box-content.readme.io/reference#comments

addCommentToFile

@OAuthProtected
@Processor(friendlyName="Comments | Create Comment")
public Comment addCommentToFile(@Default(value="#[payload]")
                                                String fileId,
                                                String message)

Used to add a comment by the user to a specific file.

Parameters:

fileId - The ID of the file.

message - The text body of the comment.

Returns:

The comment. Errors may occur if the item id is invalid, the item type is invalid/unsupported, you don’t include either a message or a tagged_message, or if the user does not have access to the item being commented on.

Api.doc:

https://box-content.readme.io/reference#add-a-comment-to-an-item

replyToComment

@OAuthProtected
@Processor(friendlyName="Comments | Reply to Comment")
public Comment replyToComment(@Default(value="#[payload]")
                                              String commentId,
                                              String message)

Replies to this comment with another message.

Parameters:

commentId - The ID of the comment.

message - The text body of the comment

Returns:

The created reply comment.

updateComment

@OAuthProtected
@Processor(friendlyName="Comments | Update Comment")
public Comment updateComment(@Default(value="#[payload]")
                                             String commentId,
                                             String message)

Used to update the message of the comment.

Parameters:

commentId - The ID of the comment.

message - The desired text for the comment message.

Returns:

The updated comment.

Api.doc:

https://box-content.readme.io/reference#change-a-comments-message

deleteComment

@OAuthProtected
@Processor(friendlyName="Comments | Delete Comment")
public void deleteComment(@Default(value="#[payload]")
                                          String commentId)

Permanently deletes a comment.

Parameters:

commentId - The ID of the comment.

Api.doc:

https://box-content.readme.io/reference#delete-a-comment

addTaskToFile

@OAuthProtected
@Processor(friendlyName="Tasks | Create Task")
public Task addTaskToFile(@Default(value="#[payload]")
                                          String fileId,
                                          @Optional
                                          String message,
                                          @Optional
                                          Date dueAt)

Used to create a single task for single user on a single file.

Parameters:

fileId - The ID of the item this task is for.

message - An optional message to include with the task.

dueAt - The day at which this task is due.

Returns:

The new task object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#create-a-task

getTaskInfo

@OAuthProtected
@Processor(friendlyName="Tasks | Get Task")
public Task getTaskInfo(@Default(value="#[payload]")
                                        String taskId)

Fetches a specific task.

Parameters:

taskId - The ID of the task.

Returns:

The specified task object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#task-object

updateTaskInfo

@OAuthProtected
@Processor(friendlyName="Tasks | Update Task")
public Task updateTaskInfo(@Default(value="#[payload]")
                                           String taskId,
                                           @RefOnly
                                           TaskInput taskInfo)

Updates a specific task.

Parameters:

taskId - The ID of the task.

taskInfo - The updated info.

Returns:

The updated task.

Api.doc:

https://box-content.readme.io/reference#update-a-task

deleteTask

@OAuthProtected
@Processor(friendlyName="Tasks | Delete Task")
public void deleteTask(@Default(value="#[payload]")
                                       String taskId)

Permanently deletes a specific task.

Parameters:

taskId - The ID of the task.

Api.doc:

https://box-content.readme.io/reference#delete-a-task

getTaskAssignments

@OAuthProtected
@Processor(friendlyName="Tasks | Get Assignments")
public List<Assignment> getTaskAssignments(@Default(value="#[payload]")
                                                           String taskId)

Retrieves all of the assignments for a given task.

Parameters:

taskId - The ID of the task.

Returns:

A collection of task assignment mini objects will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#get-the-assignments-for-a-task

getTaskAssignmentInfo

@OAuthProtected
@Processor(friendlyName="Tasks | Get Task Assignment")
public Assignment getTaskAssignmentInfo(@Default(value="#[payload]")
                                                        String assignmentId)

Fetches a specific task assignment.

Parameters:

assignmentId - The ID of the task assignment.

Returns:

The specified task assignment object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#get-a-task-assignment

addTaskAssignment

@OAuthProtected
@Processor(friendlyName="Tasks | Create Task Assignment")
public Assignment addTaskAssignment(@Default(value="#[payload]")
                                                    String taskId,
                                                    String assignTo)

Used to assign a task to a single user. There can be multiple assignments on a given task.

Parameters:

taskId - The ID of the task this assignment is for.

assignTo - The ID of the user this assignment is for.

Returns:

The new task assignment object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#create-a-task-assignment

updateTaskAssignmentInfo

@OAuthProtected
@Processor(friendlyName="Tasks | Update Task Assignment")
public Assignment updateTaskAssignmentInfo(@Default(value="#[payload]")
                                                           String assignmentId,
                                                           @RefOnly
                                                           AssignmentInput taskAssignmentInfo)

Updates a task assignment.

Parameters:

assignmentId - The ID of the task assignment.

taskAssignmentInfo - The task assignment updated info.

Returns:

The updated Assignment.

Api.doc:

https://box-content.readme.io/reference#update-a-task-assignment

deleteTaskAssignment

@OAuthProtected
@Processor(friendlyName="Tasks | Delete Task Assignment")
public void deleteTaskAssignment(@Default(value="#[payload]")
                                                 String assignmentId)

Deletes a specific task assignment.

Parameters:

assignmentId - The ID of the task assignment.

Api.doc:

https://box-content.readme.io/reference#delete-a-task-assignment

createAppUser

@OAuthProtected
@Processor(friendlyName="Users | Create User")
public User createAppUser(@FriendlyName(value="Name")@Default(value="#[payload]")
                                          String username)

Used to provision a new user in an enterprise. This method only works for enterprise admins.

Parameters:

username - The name of this user.

Returns:

Returns the full user object for the newly created user. Errors may be thrown when the fields are invalid or this API call is made from a non-admin account.

Api.doc:

https://box-content.readme.io/reference#create-an-enterprise-user

getCurrentUser

@OAuthProtected
@Processor(friendlyName="Users | Get Current User")
public User getCurrentUser(@RefOnly@Optional
                                           List<String> fields)

Retrieves information about the user who is currently logged in i.e. the user for whom this auth token was generated.

Parameters:

fields - Attribute(s) to include in the response

Returns:

Returns a single complete user object.

Api.doc:

https://box-content.readme.io/reference#get-the-current-users-information

getUserInfo

@OAuthProtected
@Processor(friendlyName="Users | Get User\'s Info")
public User getUserInfo(@Default(value="#[payload]")
                                        String userId,
                                        @RefOnly@Optional
                                        List<String> fields)

Retrieves information about a user in the enterprise. Requires enterprise administration authorization.

Parameters:

userId - The ID of the user.

fields - Attribute(s) to include in the response.

Returns:

Returns a single complete user object.

Api.doc:

https://box-content.readme.io/reference#users

getEnterpriseUsers

@OAuthProtected
@Processor(friendlyName="Users | Get Enterprise Users")
public List<User> getEnterpriseUsers()

Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

Returns:

Returns the list of all users for the Enterprise with their user_id, public_name, and login if the user is an enterprise admin.

Api.doc:

https://box-content.readme.io/reference#get-all-users-in-an-enterprise

updateUserInfo

@OAuthProtected
@Processor(friendlyName="Users | Update  User")
public User updateUserInfo(String userId,
                                           @RefOnly@Default(value="#[payload]")
                                           UserInput input)

Used to edit the settings and information about a user. This method only works for enterprise admins.

Parameters:

userId - The ID of the user.

input - User updated info.

Returns:

The updated user.

Api.doc:

https://box-content.readme.io/reference#update-a-users-information

deleteUser

@OAuthProtected
@Processor(friendlyName="Users | Delete User")
public void deleteUser(@Default(value="#[payload]")
                                       String userId,
                                       @Default(value="true")
                                       boolean notifyUser,
                                       @Default(value="false")
                                       boolean force)

Deletes a user in an enterprise account.

Parameters:

userId - The ID of the user.

notifyUser - Determines if the destination user should receive email notification of the transfer.

force - Whether or not the user should be deleted even if this user still own files.

Api.doc:

https://box-content.readme.io/reference#delete-an-enterprise-user

moveFolderToUser

@OAuthProtected
@Processor(friendlyName="Users | Move User\'s Folder")
public Folder moveFolderToUser(@Default(value="#[payload]")
                                               String userId,
                                               String targetUserId)

Moves all of the owned content from within one user’s folder into a new folder in another user’s account. You can move folders across users as long as the you have administrative permissions and the ‘source’ user owns the folders.

Parameters:

userId - The ID of the user.

targetUserId - the user id of the user whose files will be the source for this operation

Returns:

The information for the newly created destination folder. An error is thrown if you do not have the necessary permissions to move the folder.

Api.doc:

https://box-content.readme.io/reference#move-folder-into-another-users-folder

createGroup

@OAuthProtected
@Processor(friendlyName="Groups | Create Group")
public Group createGroup(@Default(value="#[payload]")
                                         String groupName)

Used to create a group.

Parameters:

groupName - The name of the new group to be created

Returns:

The new group object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#create-a-group

getGroupInfo

@OAuthProtected
@Processor(friendlyName="Groups | Get Group")
public Group getGroupInfo(@Default(value="#[payload]")
                                          String groupId)

Retrieves information about a group.

Parameters:

groupId - The ID of the group.

Returns:

A group object that was requested.

Api.doc:

https://box-content.readme.io/reference#get-group

deleteGroup

@OAuthProtected
@Processor(friendlyName="Groups | Delete Group")
public void deleteGroup(@Default(value="#[payload]")
                                        String groupId)

Permanently deletes a specific group.

Parameters:

groupId - The ID of the group.

Api.doc:

https://box-content.readme.io/reference#delete-a-group

addGroupMembership

@OAuthProtected
@Processor(friendlyName="Groups | Create Membership")
public Membership addGroupMembership(@Default(value="#[payload]")
                                                     String groupId,
                                                     String userId,
                                                     @RefOnly@Default(value="MEMBER")
                                                     MembershipRole membershipRole)

Adds a member to a Group.

Parameters:

groupId - The group this user is to be added to.

userId - The UserId of the BoxUser to assign to a group

membershipRole - The membershipRole of the user in the group. Default is “member” option for “admin”

Returns:

The new group membership object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#add-a-member-to-a-group

getGroupMemberships

@OAuthProtected
@Processor(friendlyName="Groups | Get Memberships for Group")
public List<Membership> getGroupMemberships(@Default(value="#[payload]")
                                                            String groupId)

Retrieves all of the members for a given group if the requesting user has access

Parameters:

groupId - The ID of the group.

Returns:

A collection of group membership objects will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#get-the-membership-list-for-a-group

getGroupMembership

@OAuthProtected
@Processor(friendlyName="Groups | Get Membership")
public Membership getGroupMembership(@Default(value="#[payload]")
                                                     String groupMemberShipId)

Fetches a specific group membership entry.

Parameters:

groupMemberShipId - The ID of the group membership.

Returns:

The specified group_membership object will be returned upon success.

Api.doc:

https://box-content.readme.io/reference#get-a-group-membership-entry

updateGroupMembership

@OAuthProtected
@Processor(friendlyName="Groups | Update Membership for a Group")
public Membership updateGroupMembership(String groupMemberShipId,
                                                        @RefOnly@Default(value="#[payload]")
                                                        MembershipInput groupMembership)

Updates a group membership.

Parameters:

groupMemberShipId - The ID of the group membership.

groupMembership - The updated group membership.

Returns:

The updated group membership.

Api.doc:

https://box-content.readme.io/reference#update-a-group-membership

deleteGroupMembership

@OAuthProtected
@Processor(friendlyName="Groups | Delete Membership")
public void deleteGroupMembership(@Default(value="#[payload]")
                                                  String groupMemberShipId)

Deletes a specific group membership.

Parameters:

groupMemberShipId - The ID of the group membership.

Api.doc:

https://box-content.readme.io/reference#delete-a-group-membership

getAllGroups

@OAuthProtected
@Processor(friendlyName="Groups | Get Groups for an Enterprise")
public List<Group> getAllGroups()

Retrieves all of the groups that the current user is a member of.

Returns:

A collection of group objects.

Api.doc:

https://box-content.readme.io/reference#groups

getUserGroupMemberships

@OAuthProtected
@Processor(friendlyName="Groups | Get User\'s Memberships")
public List<Membership> getUserGroupMemberships(@Default(value="#[payload]")
                                                                String userId)

Retrieves all of the group memberships for a given user. Note this is only available to group admins.

Parameters:

userId - The ID of the user.

Returns:

A collection of group membership objects will be returned upon success.

createCollaboration

@OAuthProtected
@Processor(friendlyName="Collaborations | Create Collaboration")
public Collaboration createCollaboration(@Default(value="#[payload]")
                                                         String folderId,
                                                         String collaboratorId,
                                                         @RefOnly
                                                         CollaborationRole collaborationRole)

Adds a collaboration for a single user or a single group to a folder. Either an email address, a user ID, or a group id can be used to create the collaboration.

Parameters:

folderId - The ID of the item to add the collaboration on.

collaboratorId - The collaboratorId to add.

collaborationRole - The collaborationRole of the collaboratorId.

Returns:

The new collaboration object is returned.

Api.doc:

https://box-content.readme.io/reference#add-a-collaboration

getCollaborationInfo

@OAuthProtected
@Processor(friendlyName="Collaborations | Get Collaboration")
public Collaboration getCollaborationInfo(@Default(value="#[payload]")
                                                          String collaborationId)

Retrieves information about a single collaboration.

Parameters:

collaborationId - The ID of the collaboration.

Returns:

The collaboration object is returned. Errors may occur if the IDs are invalid or if the user does not have permissions to see the collaboration.

Api.doc:

https://box-content.readme.io/reference#get-collabs

updateCollaboration

@OAuthProtected
@Processor(friendlyName="Collaborations | Update Collaboration")
public Collaboration updateCollaboration(@Default(value="#[payload]")
                                                         String collaborationId,
                                                         @RefOnly
                                                         CollaborationInput input)

Used to edit an existing collaboration. Descriptions of the various roles can be found here.

Parameters:

collaborationId - The ID of the collaboration.

input - Contains information about a BoxCollaboration.

Returns:

The updated collaboration.

Api.doc:

https://box-content.readme.io/reference#edit-a-collaboration

deleteCollaboration

@OAuthProtected
@Processor(friendlyName="Collaborations | Delete Collaboration")
public void deleteCollaboration(@Default(value="#[payload]")
                                                String collaborationId)

Used to delete a single collaboration.

Parameters:

collaborationId - The ID of the collaboration.

Api.doc:

https://box-content.readme.io/reference#remove-a-collaboration

getPendingCollaborations

@OAuthProtected
@Processor(friendlyName="Collaborations | Pending Collaborations")
public List<Collaboration> getPendingCollaborations()

Used to retrieve all pending collaboration invites for this user.

Returns:

A collection of pending collaboration objects are returned. If the user has no pending collaborations, the collection will be empty.

Api.doc:

https://box-content.readme.io/reference#get-pending-collaborations

search

@OAuthProtected
@Processor(friendlyName="Search")
public List<Item> search(@Default(value="#[payload]")
                                         String query,
                                         String parentFolderId)

The search endpoint provides a simple way of finding items that are accessible in a given user’s Box account.

Parameters:

query - The string to search for; can be matched against item names, descriptions, text content of a file, and other fields of the different item types.

parentFolderId - The ID of the folder in which the search operation will be applied. If the ID is not specified it will be done in the root folder.

Returns:

A collection of the found Item elements.

getConfig

public AbstractConfig getConfig()

setConfig

public void setConfig(AbstractConfig config)

getTaskClient

public TaskClient getTaskClient()

getAssignmentClient

public AssignmentClient getAssignmentClient()

getUserClient

public UserClient getUserClient()

getGroupClient

public GroupClient getGroupClient()

getMembershipClient

public MembershipClient getMembershipClient()