Package com.box.sdk

Provides classes and methods for interacting with the Box API.

See: Description

Interface Summary

Interface	Description
BoxAPIConnectionListener	Listener to listen to Box API connection events.
EventListener	The listener interface for receiving events from an EventStream.
IAccessTokenCache	Implement this interface to provide a custom access token cache implementation for your environment.
ProgressListener	The listener interface for monitoring the progress of a long-running API call.
RequestInterceptor	The interface for intercepting requests to the Box API.

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.
BoxDeveloperEditionAPIConnection	Represents an authenticated Box Developer Edition connection to the Box API.
BoxEnterprise	Represents an enterprise organization on Box.
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.
BoxGroupMembership	Represents a relationship between a user and a group.
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.
BoxRedirectResponse	Used to read HTTP responses containing redirect URLs in the 'LOCATION' header.
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.
BoxTask	Represents a task on Box.
BoxTaskAssignment	Represents a task assignment on Box, which can be used to assign a task to a single user.
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.
CreateUserParams	Contains optional parameters for creating a new enterprise user on Box.
EmailAlias	Represents a Box user's email alias.
EventLog	A log of events that were retrieved from the events endpoint.
EventStream	Receives real-time events from the API and forwards them to EventListeners.
FileUploadParams	Contains parameters for configuring an upload to Box.
InMemoryLRUAccessTokenCache	Use this class to create an in-memory LRU (least recently used) access token cache to be passed to BoxDeveloperEditionAPIConnection.
JWTEncryptionPreferences	Contains the encryption preferences for JWT assertion.
Metadata	The Metadata class represents one type instance of Box metadata.
PartialCollection<E>	A collection that contains a subset of items that are a part of a larger collection.
StandardCharsets	Constant definitions for the standard Charsets.

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.
BoxFile.ThumbnailFileType	Used to specify what filetype to request for a file thumbnail.
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.
BoxGroupMembership.Role	Enumerates the possible roles that a user can have within a group.
BoxSharedLink.Access	Enumerates the possible access levels that can be set on a shared link.
BoxTask.Action	Enumerates the possible actions that a task can have.
BoxTaskAssignment.ResolutionState	Enumerates the possible resolution states that a task assignment can have.
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.
DeveloperEditionEntityType	Enum to represent the JWT entity type for BoxDeveloperEditionAPIConnection.
EncryptionAlgorithm	Enum to identify algorithm for JWT.

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.