BoxConnector

The api's base url

The OAuth2 client id

The OAuth2 client secret

This list holds the source callbacks for long polling that can't yet be served because authorization hasn't happened

The url of the endpoints dedicated to file uploading operations

If set to true, Box will be asked to gzip all its responses

Used to convert one of the user’s confirmed email aliases into the user’s primary login.

Used to add a comment to a discussion.

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

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

Used to create a shared link for this particular folder

Used to add a collaboration for a single user to a folder. Either an email address or a user ID can be used to create the collaboration. Transferring ownership: To transfer ownership of a folder (as the current owner of the folder), first create a collaboration for the new user with any role. Then update that collaboration with a role of ‘owner’.

Used to create the metadata for a new discussion for a particular folder. The parent, id and name attributes of the request object are required

Adds a new email alias to the given user’s account.

Creates a new folder and returns a folder object with all its associated information

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

Used to delete a single collaboration.

Delets a comment.

Removes an email alias from a user.

Discards a file to the trash. The etag of the file can be included as an ‘If-Match’ header to prevent race conditions. Depending on the enterprise settings for this user, the item will either be actually deleted from Box or moved to the trash.

Deletes a folder

Deletes a user in an enterprise account.

Downloads a file

Used to get information about a single collaboration.

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

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

Used to retrieve all comments for a given discussion.

Retrieves all email aliases for this user. The collection of email aliases does not include the primary login for the user

Retrieves events for all users in an enterprise. Upper and lower bounds as well as filters can be applied to the results.

Use this to get events for a given user. A chunk of event objects is returned for the user based on the parameters passed in. Parameters indicating how many chunks are left as well as the next streamPosition are also returned.

Requests access to a long polling server that notifies about events in real time. This is just a request for connection details. A subscription to such topic is not made

Retrieves the comments on a particular file, if any exist.

Used to retrieve the metadata about a file.

Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32, 64x64, 128x128, and 256x256 can be returned. Currently thumbnails are only available in .png format and will only be generated for image file formats.

Retrieves information about a given folder. If the folderId parameter is not provided or equals 0, then the root folder will be returned.

Returns the folder information for a given path

Retrieves the discussions on a particular folder, if any exist.

Traverses a given folder looking for a resource (file or folder) of a given name.

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. Paginated results can be retrieved using the limit and offset parameters.

Returns the item information for a given path.

Used to retrieve all pending collaboration invites for this user.

Retrieves the metadata of a trashed file

Retrieves a folder that has been moved to the trash.

Get the folders in the Trash. Retrieves the files and/or folders that have been moved to the trash using the mini format. Paginated results can be retrieved using the limit and offset parameters.

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

Returns a list of all users for the Enterprise

If there are previous versions of this file, this method can be used to retrieve metadata about the older versions. Alert: Versions are only tracked for Box users with premium accounts.

This method initiaes the box client and the auth callback. Also, it fetches the save/restore flows (if specified). If those are specified but don't exist in the registry, then IllegalArgumentException is thrown

Message source that subscribes to the events long polling server and will trigger a new message each time an event is generated. Such message will have an instance of @{link org.mule.modules.box.model.PollingEvent} as payload and an inbound property called 'boxAccessTokenId' that will carry the accessTokenId of the user that owns the event. This source will not provide the events that are generated, it's just a notification that there're new events available. You'll need to use the get-events processor to actually get them. Managing the stream position while doing so is up to you.

Moves all of the 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. To move everything from the root folder, use 0 (zero) which always represents the root folder of a Box account

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

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

Restores a file 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.

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.

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

Used to create a shared link for this particular file.

Used to create a shared link for this particular folder

Deletes the shared link associated to a file

Deletes the shared link associated to a folder

Used to update an existing collaboration.

Used to update the message of the comment.

Used to update the metadata for an existing discussion.

Update a file’s information. Used to update individual or multiple fields in the file object, including renaming the file, changing it’s description, and creating a shared link for the file. To move a file, change the ID of its parent folder. An optional etag can be provided to ensure that client only updates the file if it knows about the latest version

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 folderUploadEmail attribute. An optional If-Match header can be included to ensure that client only updates the folder if it knows about the latest version by setting the etag attribute.

Used to edit the settings and information about a user. This method only works for enterprise admins. To roll a user out of the enterprise (and convert them to a standalone free user), update the special enterprise attribute to be null

Uploads a new version of a file by reading the contents from a path in local storage

Uploads a new version of a file from an input stream

Receives the path of a file in local storage and uploads its content

Creates a new file with the contents of a java.io.InputStream. You need to take in count that since this is a stream, using the option of including a verification hash will cause the contents of the input stream to be fully read and loaded in memory.