Package com.box.sdk

Provides classes and methods for interacting with the Box API.

See: Description

Interface Summary

Interface	Description
EventListener	The listener interface for receiving events from an EventStream.
ProgressListener	The listener interface for monitoring the progress of a long-running API call.

Class Summary

Class	Description
BoxAPIConnection	Represents an authenticated connection to the Box API.
BoxAPIRequest	Used to make HTTP requests to the Box API.
BoxAPIResponse	Used to read HTTP responses from the Box API.
BoxCollaboration	Represents a collaboration between a user and another user or group.
BoxCollaborator	The abstract base class for types that can be added to collaborations.
BoxComment	Represents a comment on a file.
BoxDateFormat	Contains methods for parsing and formatting dates for use with the Box API.
BoxEvent	Represents an event that was fired off by the Box events API.
BoxFile	Represents an individual file on Box.
BoxFileVersion	Represents a particular version of a file on Box.
BoxFolder	Represents a folder on Box.
BoxGroup	Represents a set of Box users.
BoxItem	The abstract base class for items in a user's file tree (files, folders, etc.).
BoxJSONObject	The abstract base class for all types that contain JSON data returned by the Box API.
BoxJSONRequest	Used to make HTTP requests containing JSON to the Box API.
BoxJSONResponse	Used to read HTTP responses containing JSON from the Box API.
BoxMultipartRequest	Used to make HTTP multipart requests to the Box API.
BoxResource	The abstract base class for all resource types (files, folders, comments, collaborations, etc.) used by the API.
BoxSharedLink	Represents a link to a file or folder on Box.
BoxSharedLink.Permissions	Contains permissions fields that can be set on a shared link.
BoxTrash	Provides methods for deleting, recovering, and viewing a user's trashed files and folders.
BoxUploadEmail	Represents an email address that can be used to upload files to a folder on Box.
BoxUser	Represents a Box user account.
EventStream	Receives real-time events from the API and forwards them to EventListeners.
FileUploadParams	Contains parameters for configuring an upload to Box.
PartialCollection<E>	A collection that contains a subset of items that are a part of a larger collection.

Enum Summary

Enum	Description
BoxCollaboration.Role	Enumerates the possible access levels that a collaborator can have.
BoxCollaboration.Status	Enumerates the possible statuses that a collaboration can have.
BoxEvent.Type	Enumerates the possible types for an event.
BoxFile.Permission	Enumerates the possible permissions that a user can have on a file.
BoxFolder.Permission	Enumerates the possible permissions that a user can have on a folder.
BoxFolder.SyncState	Enumerates the possible sync states that a folder can have.
BoxSharedLink.Access	Enumerates the possible access levels that can be set on a shared link.
BoxUploadEmail.Access	Enumerates the possible access levels that can be set on an upload email.
BoxUser.Role	Enumerates the possible roles that a user can have within an enterprise.
BoxUser.Status	Enumerates the possible statuses that a user's account can have.

Exception Summary

Exception	Description
BoxAPIException	Thrown to indicate that an error occurred while communicating with the Box API.

Package com.box.sdk Description

Provides classes and methods for interacting with the Box API.