Classes Reference


                    
                    
                    BoxSDK

Provides methods for creating BoxSDKClient

Declaration

Swift

public class BoxSDK


                    
                    
                    BoxClient

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

Declaration

Swift

public class BoxClient

extension BoxClient: BoxClientProtocol


                    
                    
                    BoxAPIAuthError

Describes authentication errors.

Declaration

Swift

public class BoxAPIAuthError : BoxAPIError


                    
                    
                    BoxAPIError

Describes API request related errors.

Declaration

Swift

public class BoxAPIError : BoxSDKError


                    
                    
                    BoxCodingError

Describes encoding and decoding related errors.

Declaration

Swift

public class BoxCodingError : BoxSDKError


                    
                    
                    BoxNetworkError

Describes network related errors.

Declaration

Swift

public class BoxNetworkError : BoxSDKError


                    
                    
                    BoxSDKError

Describes general SDK errors

Declaration

Swift

public class BoxSDKError : Error

extension BoxSDKError: CustomStringConvertible

extension BoxSDKError: LocalizedError


                    
                    
                    MetadataSearchFilter

Provides functionality for creating a Metadata Search Filter.

Declaration

Swift

public class MetadataSearchFilter


                    
                    
                    ConsoleLogDestination

Defines logging into a console

Declaration

Swift

public class ConsoleLogDestination : LogDestination


                    
                    
                    FileLogDestination

Defines logging into a file

Declaration

Swift

public class FileLogDestination : LogDestination


                    
                    
                    AuthModule

Provides Token management.

Declaration

Swift

public class AuthModule : TokenRefreshing


                    
                    
                    CCGAuthModule

Provides management for Client Credentials Grant authentication.

Declaration

Swift

public class CCGAuthModule : AuthModule


                    
                    
                    CollaborationAllowlistModule

Provides Collaborations management.

Declaration

Swift

public class CollaborationAllowlistModule


                    
                    
                    CollaborationsModule

Provides Collaborations management.

Declaration

Swift

public class CollaborationsModule


                    
                    
                    CollectionsModule

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

Declaration

Swift

public class CollectionsModule


                    
                    
                    CommentsModule

Provides Comment management

Declaration

Swift

public class CommentsModule


                    
                    
                    DevicePinsModule

Provides DevicePin management.

Declaration

Swift

public class DevicePinsModule


                    
                    
                    EventsModule

Provides Event management.

Declaration

Swift

public class EventsModule


                    
                    
                    FileRequestsModule

Provides management of FileRequests

Declaration

Swift

public class FileRequestsModule


                    
                    
                    FilesModule

Provides File management.

Declaration

Swift

public class FilesModule


                    
                    
                    FoldersModule

Provides Folder management.

Declaration

Swift

public class FoldersModule


                    
                    
                    GroupsModule

Provides Group management

Declaration

Swift

public class GroupsModule


                    
                    
                    LegalHoldsModule

Provides management of Legal Holds

Declaration

Swift

public class LegalHoldsModule


                    
                    
                    MetadataCascadePolicyModule

Defines methods for metadata management

Declaration

Swift

public class MetadataCascadePolicyModule


                    
                    
                    MetadataModule

Defines methods for metadata management

Declaration

Swift

public class MetadataModule


                    
                    
                    RecentItemsModule

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

Declaration

Swift

public class RecentItemsModule


                    
                    
                    RetentionPoliciesModule

Provides RetentionPolicy management.

Declaration

Swift

public class RetentionPoliciesModule


                    
                    
                    SearchModule

Provides functionality to search for content.

Declaration

Swift

public class SearchModule


                    
                    
                    SharedItemsModule

Provides SharedItem management.

Declaration

Swift

public class SharedItemsModule


                    
                    
                    SignRequestsModule

Provides management of Sign Requests

Declaration

Swift

public class SignRequestsModule


                    
                    
                    StoragePoliciesModule

Provides management of Storage Policies

Declaration

Swift

public class StoragePoliciesModule


                    
                    
                    TasksModule

Provides Tasks management

Declaration

Swift

public class TasksModule


                    
                    
                    TermsOfServicesModule

Provides TermsOfService management.

Declaration

Swift

public class TermsOfServicesModule


                    
                    
                    TrashModule

Module for trash management

Declaration

Swift

public class TrashModule


                    
                    
                    UsersModule

Provides User management.

Declaration

Swift

public class UsersModule


                    
                    
                    WebLinksModule

Provides Web Link management.

Declaration

Swift

public class WebLinksModule


                    
                    
                    WebhooksModule

Provides management of Webhooks

Declaration

Swift

public class WebhooksModule


                    
                    
                    BoxDownloadTask

A Box network task for a download

Declaration

Swift

public class BoxDownloadTask : BoxNetworkTask


                    
                    
                    BoxNetworkAgent

Implementation of networking layer

Declaration

Swift

public class BoxNetworkAgent : NSObject, NetworkAgentProtocol


                    
                    
                    BoxNetworkTask

A Box network task request.

Declaration

Swift

public class BoxNetworkTask : Cancellable


                    
                    
                    BoxUploadTask

A Box network task returned for a upload

Declaration

Swift

public class BoxUploadTask : BoxNetworkTask


                    
                    
                    PagingIterator

Provides paged iterator access for a collection of BoxModel’s

Declaration

Swift

public class PagingIterator<Element> where Element : BoxModel


                    
                    
                    BoxRequest

Represents Box SDK API request.

Declaration

Swift

public class BoxRequest


                    
                    
                    BoxCollection

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.

Declaration

Swift

public class BoxCollection : BoxModel


                    
                    
                    Classification

Details about the classification applied to a Box file or folder

Declaration

Swift

public class Classification : BoxModel


                    
                    
                    Collaboration

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.

Declaration

Swift

public class Collaboration : BoxModel


                    
                    
                    CollaborationAllowlistEntry

An allowlisted domain in the enterprise. This record consists of both direction (inbound, outbound, or both) and a domain (box.com).

Declaration

Swift

public class CollaborationAllowlistEntry : BoxModel


                    
                    
                    CollaborationAllowlistExemptTarget

The record that represents a target (at the moment, only users are supported as targets) that is exempt from the collaboration allowlist.

Declaration

Swift

public class CollaborationAllowlistExemptTarget : BoxModel


                    
                    
                    Collaborator

User taking part in a collaboration.

Declaration

Swift

public class Collaborator : BoxModel


                    
                    
                    Comment

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.

Declaration

Swift

public class Comment : BoxModel


                    
                    
                    DevicePin

Defines a device pin which allows the enterprise to control devices connecting to it.

Declaration

Swift

public class DevicePin : BoxModel


                    
                    
                    EmailAlias

User’s email alias.

Declaration

Swift

public class EmailAlias : BoxModel


                    
                    
                    Enterprise

Enterprise

Declaration

Swift

public class Enterprise : BoxModel


                    
                    
                    EntryContainer

Container for an entries (Box items)

Declaration

Swift

public class EntryContainer<T> : BoxModel where T : BoxModel


                    
                    
                    Order

Defines the order of items

Declaration

Swift

public class Order : BoxModel


                    
                    
                    EntryContainerInnerModel

Entry container for items of inner model

Declaration

Swift

public class EntryContainerInnerModel<T> : BoxInnerModel where T : BoxInnerModel


                    
                    
                    Event

An event object associated with user or enterprise events.

Declaration

Swift

public class Event : BoxModel


                    
                    
                    EventContainer

Container for Events

Declaration

Swift

@available(*, deprecated, message: "This class is obsoleted and will be removed. Please use EntryContainer<Element> instead.")
public class EventContainer : BoxModel


                    
                    
                    EventItem

A metadata object associated with a file or a folder.

Declaration

Swift

public class EventItem : BoxModel


                    
                    
                    ExpiringEmbedLink

Expiring embed link of a file

Declaration

Swift

public class ExpiringEmbedLink : BoxModel


                    
                    
                    File

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

Declaration

Swift

public class File : BoxModel


                    
                    
                    FileRequest

Undocumented

Declaration

Swift

public final class FileRequest : BoxModel


                    
                    
                    FileVersion

Specific version of a file.

Declaration

Swift

public class FileVersion : BoxModel


                    
                    
                    FileVersionLegalHold

A file version legal hold object represents all holds on a file version

Declaration

Swift

public class FileVersionLegalHold : BoxModel


                    
                    
                    FileVersionRetention

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

Declaration

Swift

public class FileVersionRetention : BoxModel


                    
                    
                    Folder

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

Declaration

Swift

public class Folder : BoxModel


                    
                    
                    FolderLock

Folder Lock

Declaration

Swift

public class FolderLock : BoxModel


                    
                    
                    FolderUploadEmail

Defines upload email address for a folder.

Declaration

Swift

public class FolderUploadEmail : BoxInnerModel


                    
                    
                    Group

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

Declaration

Swift

public class Group : BoxModel


                    
                    
                    GroupMembership

Membership of a group

Declaration

Swift

public class GroupMembership : BoxModel


                    
                    
                    Invite

Defines invitation for a user to join enterprise

Declaration

Swift

public class Invite : BoxModel


                    
                    
                    LegalHoldPolicy

Legal hold policy

Declaration

Swift

public class LegalHoldPolicy : BoxModel


                    
                    
                    LegalHoldPolicyAssignment

Legal hold policy assignment

Declaration

Swift

public class LegalHoldPolicyAssignment : BoxModel


                    
                    
                    LegalHoldPolicyAssignmentItem

Legal hold policy assignment item

Declaration

Swift

public class LegalHoldPolicyAssignmentItem : BoxModel


                    
                    
                    Lock

Locks a file to prevent it from being modified

Declaration

Swift

public class Lock : BoxModel


                    
                    
                    MetadataCascadePolicy

A metadata object associated with a file or a folder.

Declaration

Swift

public class MetadataCascadePolicy : BoxModel


                    
                    
                    MetadataObject

A metadata object associated with a file or a folder.

Declaration

Swift

public class MetadataObject : BoxModel


                    
                    
                    MetadataTemplate

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.

Declaration

Swift

public class MetadataTemplate : BoxModel


                    
                    
                    PathCollection

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

Declaration

Swift

public class PathCollection : BoxModel


                    
                    
                    PollingResult

An events long polling result.

Declaration

Swift

public class PollingResult : BoxModel


                    
                    
                    PollingURLInfo

Polling URL info for requesting changes in event stream.

Declaration

Swift

public class PollingURLInfo : BoxModel


                    
                    
                    RecentItem

Item recently iteracted with

Declaration

Swift

public class RecentItem : BoxModel


                    
                    
                    RetentionPolicy

A retention policy blocks permanent deletion of content for a specified amount of time.

Declaration

Swift

public class RetentionPolicy : BoxModel


                    
                    
                    RetentionPolicyAssignment

The retention policy assignment provides a way for admins to apply a retention policy on a per-folder basis, or place a blanket policy over the entire enterprise.

Declaration

Swift

public class RetentionPolicyAssignment : BoxModel


                    
                    
                    RetentionPolicyAssignmentItem

The type and id of the content that is under retention.

Declaration

Swift

public class RetentionPolicyAssignmentItem : BoxModel


                    
                    
                    RetentionPolicyEntry

Retention policy entry

Declaration

Swift

public class RetentionPolicyEntry : BoxModel


                    
                    
                    Scope

Permission scope for a token.

Declaration

Swift

public class Scope : BoxModel


                    
                    
                    SearchResult

Files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user.

Declaration

Swift

public class SearchResult : BoxModel


                    
                    
                    SharedItem

Item shared by shared link.

Declaration

Swift

public class SharedItem : BoxModel


                    
                    
                    SharedLink

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

Declaration

Swift

public class SharedLink : BoxModel


                    
                    
                    SignRequest

A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

Declaration

Swift

public class SignRequest : BoxModel


                    
                    
                    SignRequestPrefillTag

Prefill tags are used to prefill placeholders with signer input data. Only one value field can be included.

Declaration

Swift

public class SignRequestPrefillTag : BoxInnerModel


                    
                    
                    SignRequestSignFiles

List of files that will be signed, which are copies of the original source files. A new version of these files are created as signers sign and can be downloaded at any point in the signing process.

Declaration

Swift

public class SignRequestSignFiles : BoxModel


                    
                    
                    SignRequestSigner

Represents a signer fields for GET Sign Request response.

Declaration

Swift

public class SignRequestSigner : BoxModel


                    
                    
                    SignRequestSignerDecision

Final decision made by the signer

Declaration

Swift

public class SignRequestSignerDecision : BoxModel


                    
                    
                    SignRequestSignerInput

Prefill tags are used to prefill placeholders with signer input data. Only none value field can be included.

Declaration

Swift

public class SignRequestSignerInput : BoxModel


                    
                    
                    StoragePolicy

Storage policy

Declaration

Swift

public class StoragePolicy : BoxModel


                    
                    
                    StoragePolicyAssignment

Storage policy assignment

Declaration

Swift

public class StoragePolicyAssignment : BoxModel


                    
                    
                    Task

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.

Declaration

Swift

public class Task : BoxModel


                    
                    
                    TaskAssignment

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

Declaration

Swift

public class TaskAssignment : BoxModel


                    
                    
                    TermsOfService

The Terms of Service allows Box Admins to configure a custom ToS indicating to users. Users can accept/ re-accept for custom applications.

Declaration

Swift

public class TermsOfService : BoxModel


                    
                    
                    TermsOfServiceUserStatus

Represents a Terms of Service status for a given user.

Declaration

Swift

public class TermsOfServiceUserStatus : BoxModel


                    
                    
                    Token

Embed link token

Declaration

Swift

public class Token : BoxModel


                    
                    
                    TokenInfo

Info about the tokens used by the SDK for authentication.

Declaration

Swift

public class TokenInfo : Codable

extension TokenInfo: Equatable


                    
                    
                    TrackingCode

Admin-defined information about a user

Declaration

Swift

@available(*, deprecated, message: "This class is obsoleted and will be removed. Please use User.TrackingCode instead.")
public class TrackingCode : BoxModel


                    
                    
                    UploadPart

Object representing part of chunked upload.

Declaration

Swift

public class UploadPart : BoxModel


                    
                    
                    UploadSession

Session object for chunked upload.

Declaration

Swift

public class UploadSession : BoxModel


                    
                    
                    User

User of the Box application.

Declaration

Swift

public class User : BoxModel


                    
                    
                    UserAvatarUpload

Box representation of a upload avatar response

Declaration

Swift

public class UserAvatarUpload : BoxModel


                    
                    
                    Watermark

Watermark object labels folders and files to be protected by watermarks, which will show on file previews. Watermarks can be applied to folders and files independently.

Declaration

Swift

public class Watermark : BoxModel


                    
                    
                    WebLink

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

Declaration

Swift

public class WebLink : BoxModel


                    
                    
                    Webhook

Defines a Webhook, which enables event triggers to be attached to Box files and folders

Declaration

Swift

public class Webhook : BoxModel


                    
                    
                    ZipDownload

Defines a Zip Download

Declaration

Swift

public class ZipDownload : BoxModel


                    
                    
                    ZipDownloadConflict

Defines a Zip Download Conflict

Declaration

Swift

public class ZipDownloadConflict : BoxModel


                    
                    
                    ZipDownloadConflictItem

Defines a Zip Download Conflict Item

Declaration

Swift

public class ZipDownloadConflictItem : BoxModel


                    
                    
                    ZipDownloadStatus

Status of a Zip download

Declaration

Swift

public class ZipDownloadStatus : BoxModel


                    
                    
                    CCGAuthSession

An authorization session using Client Credentials Grant

Declaration

Swift

public class CCGAuthSession : SessionProtocol, ExpiredTokenHandling


                    
                    
                    DelegatedAuthSession

An authorization session using JWT token

Declaration

Swift

public class DelegatedAuthSession : SessionProtocol


                    
                    
                    OAuth2Session

OAuth 2 Session

Declaration

Swift

public class OAuth2Session : SessionProtocol, ExpiredTokenHandling


                    
                    
                    SingleTokenSession

Developer session that only requires a developer token. Session will only work as long as the token is valid.

Declaration

Swift

public class SingleTokenSession : SessionProtocol


                    
                    
                    KeychainTokenStore

Token store that uses the Apple keychain

Declaration

Swift

public class KeychainTokenStore : TokenStore