Classes

Provides methods for creating BoxSDKClient

Provides communication with Box APIs. Defines methods for communication with Box APIs

Provides functionality for creating a Metadata Search Filter.

Defines logging into a console

Defines logging into a file

Provides Token management.

Provides Collaborations management.

Management of collections of files and folders. The only collection available is the Favorites.

Provides Comment management

Provides File management.

Provides Folder management.

Defines methods for metadata management

Returns information about files that have been accessed by a user not long ago.

Provides functionality to search for content.

Provides SharedItem management.

Module for trash management

Provides User management.

Provides Web Link management.

Implementation of networking layer

Defines paginations for list of box items.

Implements pagination using offset. Learn more about offset based pagination here

Implements pagination using marker. Learn more about marker based pagination here

Represents Box SDK API request.

Collections contain information about the items contained inside of them, including files and folders. The only collection available is the “Favorites” collection. The contents of the collection are discovered in a similar way in which the contents of a folder are discovered.

Defines access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role.

The file or folder that access is granted to by collaboration.

User taking part in a collaboration.

Message generated by Box users. Each message is tied to a specific file. You can create comments independently or create them as responses to other comments.

Item a comment was placed on

User’s email alias.

Enterprise

Container for an entries (Box items)

Defines the order of items

Entry container for items of inner model

Expiring embed link of a file

File objects in Box, with attributes like who created the file, when it was last modified, and other information.

Specific version of a file.

File objects in Box, with attributes like who created the file, when it was last modified, and other information.

Files, folders, or web links contained within a folder.

Defines upload email address for a folder.

Contain a set of users, and can be used in place of users in some operations, such as collaborations.

Defines invitation for a user to join enterprise

Locks a file to prevent it from being modified

A metadata object associated with a file or a folder.

Metadata that belongs to a file or folder is grouped by templates. Templates allow the metadata service to provide a multitude of services, such as pre-defining sets of key:value pairs or schema enforcement on specific fields.

The path of folders to an item, starting at the root.

Undocumented

Permission scope for a token.

Item shared by shared link.

Provides direct, read-only access to files or folder on Box using a URL

Defines shared link permissions

Enables file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box. You can read more about tasks in Box here.

Task assignment to a single user. There can be multiple assignments on a given task.

Embed link token

Info about the tokens used by the SDK for authentication.

Admin-defined information about a user

Object representing part of chunked upload.

Session object for chunked upload.

User of the Box application.

Object that points to URLs. These objects are also known as bookmarks within the Box web application.

An authorization session using JWT token

Undocumented