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.
IPrivateKeyDecryptor	Implement this interface to provide a custom private key decryptor.
ProgressListener	The listener interface for monitoring the progress of a long-running API call.
RequestInterceptor	The interface for intercepting requests to the Box API.
UploadFileCallback	The callback which allows file content to be written on output stream.

Class Summary

Class	Description
AvatarUploadResponse	Upload avatar response
BCPrivateKeyDecryptor	The default implementation of `IPrivateKeyDecryptor`, which uses Bouncy Castle library to decrypt the private key.
BoxAI
BoxAIAgent
BoxAIAgentAsk	Represents an AI Agent used to handle queries.
BoxAIAgentAskBasicText	AI agent tool used to handle basic text.
BoxAIAgentAskLongText	Represents an AI agent tool used to handle longer text.
BoxAIAgentEmbeddings	Represents the embeddings used by an AI agent.
BoxAIAgentEmbeddingsStrategy	Represents the strategy used for the AI Agent for calculating embeddings.
BoxAIAgentExtract	Represents an AI Agent used for extraction.
BoxAIAgentExtractStructured	Represents an AI Agent used for extraction.
BoxAIAgentLLMEndpointParams	The parameters for the LLM endpoint specific to OpenAI / Google models.
BoxAIAgentLLMEndpointParamsGoogle	Represents the AI LLM endpoint params Google object.
BoxAIAgentLLMEndpointParamsOpenAI	Represents the AI LLM endpoint params OpenAI object.
BoxAIAgentTextGen	Represents an AI Agent used for generating text.
BoxAIAgentTextGenBasicGen	Represents the AI agent basic tool used to generate text.
BoxAIDialogueEntry	Represents an entry of the history of prompts and answers previously passed to the LLM.
BoxAIExtractField
BoxAIExtractFieldOption
BoxAIExtractMetadataTemplate
BoxAIExtractStructuredResponse	AI response to a user request.
BoxAIItem	Represents a Box File to be included in a sign request.
BoxAIResponse	AI response to a user request.
BoxAPIConnection	Represents an authenticated connection to the Box API.
BoxAPIRequest	Used to make HTTP requests to the Box API.
BoxAPIRequest.RequestHeader	Class for mapping a request header and value.
BoxAPIResponse	Used to read HTTP responses from the Box API.
BoxCCGAPIConnection	Creates and manages Client Credentials Grant API connection.
BoxClassification	Represents the classification information for a File or Folder on Box.
BoxCollaboration	Represents a collaboration between a user and another user or group.
BoxCollaborationAllowlist	Represents a collaboration allowlist between a domain and a Box Enterprise.
BoxCollaborationAllowlistExemptTarget	Represents a collaboration allowlist between a user and a Box Enterprise.
BoxCollaborator	The abstract base class for types that can be added to collaborations.
BoxCollection	Collections contain information about the items contained inside of them, including files and folders.
BoxComment	Represents a comment on a file.
BoxConfig	Contains Box configurations.
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.
BoxDevicePin	Represents a device pin.
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.
BoxFileRequest	Represents a file request on Box.
BoxFileUploadSession	This API provides a way to reliably upload larger files to Box by chunking them into a sequence of parts.
BoxFileUploadSession.Endpoints	Represents the end points specific to an upload session.
BoxFileUploadSessionPart	Represents a part of the file that is uploaded.
BoxFileUploadSessionPartList	Contains the list of parts of a large file that are already uploaded.
BoxFileVersion	Represents a particular version of a file on Box.
BoxFileVersionLegalHold	Representing all holds on a file version.
BoxFileVersionRetention	Represents a file version retention.
BoxFileVersionRetention.QueryFilter	Represents possible query filters for "Get File Version Retentions" function.
BoxFolder	Represents a folder on Box.
BoxFolderLock	Represents a lock on a folder.
BoxGlobalSettings	Global settings to apply to all API requests.
BoxGroup	Represents a set of Box users.
BoxGroupMembership	Represents a relationship between a user and a group.
BoxInvite	Represents an invitation for a user to join an enterprise.
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.
BoxLegalHoldAssignment	Represents a legal hold policy assignment.
BoxLegalHoldPolicy	Represents a legal hold policy.
BoxLock	Represents a lock associated with a File on Box.
BoxLogger	Logger class.
BoxMetadataCascadePolicy	Represents a Metadata Cascade Policy.
BoxMetadataFilter	BoxMetadataFilter is used to help organize the request for when making metadata filter request in conjuction with search.
BoxMetadataQueryItem	Represents an individual item returned by a metadata query item.
BoxMultipartRequest	Used to make HTTP multipart requests to the Box API.
BoxNotificationEmail	Represents a notification email object
BoxRecentItem	Represents an individual recent item.
BoxRecents	Utility class to retrieve list of recent items.
BoxResource	The abstract base class for all resource types (files, folders, comments, collaborations, etc.) used by the API.
BoxResourceIterable<T>	Common implementation for paging support.
BoxRetentionPolicy	Represents a retention policy.
BoxRetentionPolicyAssignment	Represents a retention policy assignment.
BoxSearch	Represents search on Box.
BoxSearchParameters	Used to Setup Box Search Parameters
BoxSearchSharedLink	Represents a search item when searching shared links.
BoxSensitiveDataSanitizer	Class used to sanitize sensitive data from payload.
BoxSharedLink	Represents a link to a file or folder on Box.
BoxSharedLink.Permissions	Contains permissions fields that can be set on a shared link.
BoxSignRequest	Represents a Sign Request used by Box Sign.
BoxSignRequestCreateParams	Optional parameters for creating a Sign Request.
BoxSignRequestFile	Represents a Box File to be included in a sign request.
BoxSignRequestPrefillTag	Represents a prefill tag used in BoxSignRequest.
BoxSignRequestSigner	Represents a signer in BoxSignRequest.
BoxSignTemplate	Represents a Sign Template used in the Box Sign API.
BoxSignTemplateAdditionalInfo	Box Sign Template additional information on which fields are required and which fields are not editable.
BoxSignTemplateAdditionalInfoRequired	Box Sign Template additional information on which fields are required.
BoxSignTemplateCustomBranding	Custom branding applied to notifications and signature requests.
BoxSignTemplateReadySignLink	Box's ready-sign link feature enables you to create a link to a signature request that you've created from a template.
BoxSignTemplateSigner	Box Sign Template signer.
BoxStoragePolicy	Represents a BoxStoragePolicy.
BoxStoragePolicyAssignment	Represents a BoxStoragePolicyAssignment.
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.
BoxTermsOfService	Represents a custom Box Terms of Service object.
BoxTermsOfServiceUserStatus	Represents a user status on a custom Box Terms of Service object.
BoxTransactionalAPIConnection	Represents an authenticated transactional connection to the Box API.
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.
BoxWatermark	Represents a watermark.
BoxWebHook	Box WebHook resource.
BoxWebHook.Target	WebHook target - file or folder.
BoxWebHookSignatureVerifier	Signature verifier for Webhook Payload.
BoxWebLink	Represents an individual WebLink file on Box.
BoxZip	Provides methods to allow users to download multiple files and folders as a single zip file.
BoxZipConflict	Represents a conflict that occurs between items that have the same name.
BoxZipConflictItem	Represents items that have naming conflicts when creating a zip file.
BoxZipDownloadStatus	Represents the download status of a zip file.
BoxZipInfo	Represents items that have naming conflicts when creating a zip file.
BoxZipItem	Represents a Box item to be included when creating a zip file.
CreateUserParams	Contains optional parameters for creating a new enterprise user on Box.
DateRange	Class is used to be a range for two dates.
EmailAlias	Represents a Box user's email alias.
EnterpriseEventsRequest	Class describing request to get Admin Logs.
EnterpriseEventsStreamRequest	Class describing request to get Admin Logs Streaming.
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.
LargeFileUpload	Utility class for uploading large files.
LargeFileUploadTask
Metadata	The Metadata class represents one type instance of Box metadata.
MetadataFieldFilter	Filter for matching against a metadata field.
MetadataQuery	Represents Metadata Query.
MetadataQuery.OrderBy
MetadataTemplate	The MetadataTemplate class represents the Box metadata template object.
MetadataTemplate.Field	Class contains information about the metadata template field.
MetadataTemplate.FieldOperation	Posssible operations that can be performed in a Metadata template.
MetadataTemplate.Option	Class contains information about the metadata template option.
MetadataTemplate.StaticConfig	Class contains information about the static configuration for the classification.
PagingParameters	Abstraction on how SDK is doing pagination.
PartialCollection<E>	A collection that contains a subset of items that are a part of a larger collection.
Representation	The class represents one instance of a file representation.
RetentionPolicyParams	Optional parameters for creating an updating a Retention Policy.
ScopedToken
SharedLinkAPIConnection	Deprecated Use BoxItem.getSharedItem(BoxAPIConnection, String, String, String...) instead
SizeRange	Class is used to be a range for two byte numbers.
SortParameters	Represents sorting parameters.
StandardCharsets	Constant definitions for the standard Charsets.
URLTemplate	A template class to build URLs from base URL, path, URL parameters and Query String.
ZstdInterceptor	Interceptor that adds zstd compression support to API requests.

Enum Summary

Enum	Description
BoxAI.Mode
BoxAIAgent.Mode	The type of the AI agent for asking questions.
BoxAIItem.Type
BoxAPIConnection.ResourceLinkType	Used to categorize the types of resource links.
BoxCollaboration.Role	Enumerates the possible access levels that a collaborator can have.
BoxCollaboration.Status	Enumerates the possible statuses that a collaboration can have.
BoxCollaborationAllowlist.AllowlistDirection	Enumerates the direction of the collaboration allowlist.
BoxCollaborator.CollaboratorType	Enumerates the possible types of collaborations.
BoxCollaborator.GroupType	Enumerates the possible types of groups.
BoxEvent.EventType	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.
BoxFileRequest.Status	The status of the file request.
BoxFolder.Permission	Enumerates the possible permissions that a user can have on a folder.
BoxFolder.SortDirection	Used to specify what direction to sort and display results.
BoxFolder.SyncState	Enumerates the possible sync states that a folder can have.
BoxGroupMembership.GroupRole	Enumerates the possible roles that a user can have within a group.
BoxGroupMembership.Permission	Enumerates the possible permissions that a user can have as a group admin.
BoxRetentionPolicy.BoxRetentionPolicyAction	The disposition action of the retention policy.
BoxSharedLink.Access	Enumerates the possible access levels that can be set on a shared link.
BoxSignRequest.BoxSignRequestStatus	Represents a status of the sign request.
BoxSignRequestSignatureColor	Specific, forced color for a signature.
BoxSignRequestSigner.BoxSignRequestInputContentType	Represents a content type of input.
BoxSignRequestSigner.BoxSignRequestInputType	Represents a type of input.
BoxSignRequestSigner.BoxSignRequestSignerDecisionType	Type of decision made by signer.
BoxSignRequestSignerRole	Defines the role of the signer in the sign request.
BoxSignTemplateSigner.BoxSignTemplateSignerInputContentType	Box Sign Template signer input content type.
BoxSignTemplateSigner.BoxSignTemplateSignerInputType	Box Sign Template signer input type.
BoxTask.Action	Enumerates the possible actions that a task can have.
BoxTask.CompletionRule	Enumerates the possible completion rules for a task.
BoxTaskAssignment.ResolutionState	Enumerates the possible resolution states that a task assignment can have.
BoxTermsOfService.TermsOfServiceStatus	Enumerates the possible status that a terms of service can have.
BoxTermsOfService.TermsOfServiceType	Enumerates the possible types of terms of service.
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.
BoxWebHook.Trigger	A Box related triggers.
BoxWebHookSignatureVerifier.BoxSignatureAlgorithm	Box Signature Algorithms.
BoxZipDownloadStatus.State	Enumerates the possible download states of a zip.
DeveloperEditionEntityType	Enum to represent the JWT entity type for BoxDeveloperEditionAPIConnection.
EncryptionAlgorithm	Enum to identify algorithm for JWT.
MetadataTemplate.Operation	Possible template operations.
RetentionPolicyParams.RetentionType	The type of retention.

Exception Summary

Exception	Description
BoxAPIException	Thrown to indicate that an error occurred while communicating with the Box API.
BoxAPIResponseException	Thrown to indicate than an error occured while returning with a response from the Box API.
BoxDeserializationException	A class representing exceptions caused from deserializing errors.

Annotation Types Summary

Annotation Type	Description
BoxResourceType	Type of resource (e.g.: folder, file, comment, etc...).

Package com.box.sdk Description

Provides classes and methods for interacting with the Box API.