Classes

The following classes are available globally.

  • Provides methods for creating BoxSDKClient

    See more

    Declaration

    Swift

    public class BoxSDK

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

    See more

    Declaration

    Swift

    public class BoxClient

  • Describes general SDK errors

    See more

    Declaration

    Swift

    public class BoxSDKError : Error

  • Provides functionality for creating a Metadata Search Filter.

    See more

    Declaration

    Swift

    public class MetadataSearchFilter

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

    See more

    Declaration

    Swift

    public class CollectionsModule

  • Defines methods for metadata management

    See more

    Declaration

    Swift

    public class MetadataModule

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

    See more

    Declaration

    Swift

    public class RecentItemsModule

  • Provides functionality to search for content.

    See more

    Declaration

    Swift

    public class SearchModule

  • Provides paged iterator access for a collection of BoxModel’s

    See more

    Declaration

    Swift

    public class PagingIterator<Element> where Element : BoxModel

  • Represents Box SDK API request.

    See more

    Declaration

    Swift

    public class BoxRequest

  • 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.

    See more

    Declaration

    Swift

    public class BoxCollection : BoxModel

  • 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.

    See more

    Declaration

    Swift

    public class Collaboration : BoxModel

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

    See more

    Declaration

    Swift

    public class CollaborationWhitelistEntry : BoxModel

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

    See more

    Declaration

    Swift

    public class CollaborationWhitelistExemptTarget : BoxModel

  • 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.

    See more

    Declaration

    Swift

    public class Comment : BoxModel

  • An event object associated with user or enterprise events.

    See more

    Declaration

    Swift

    public class Event : BoxModel

  • A metadata object associated with a file or a folder.

    See more

    Declaration

    Swift

    public class EventItem : BoxModel

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

    See more

    Declaration

    Swift

    public class File : BoxModel

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

    See more

    Declaration

    Swift

    public class FileVersionRetention : BoxModel

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

    See more

    Declaration

    Swift

    public class Folder : BoxModel

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

    See more

    Declaration

    Swift

    public class Group : BoxModel

  • Defines invitation for a user to join enterprise

    See more

    Declaration

    Swift

    public class Invite : BoxModel

  • Locks a file to prevent it from being modified

    See more

    Declaration

    Swift

    public class Lock : BoxModel

  • 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.

    See more

    Declaration

    Swift

    public class MetadataTemplate : BoxModel

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

    See more

    Declaration

    Swift

    public class RetentionPolicy : BoxModel

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

    See more

    Declaration

    Swift

    public class SharedLink : BoxModel

  • 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.

    See more

    Declaration

    Swift

    public class Task : BoxModel

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

    See more

    Declaration

    Swift

    public class TaskAssignment : BoxModel

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

    See more

    Declaration

    Swift

    public class TermsOfService : BoxModel

  • Info about the tokens used by the SDK for authentication.

    See more

    Declaration

    Swift

    public class TokenInfo : Codable

  • 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.

    See more

    Declaration

    Swift

    public class Watermark : BoxModel

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

    See more

    Declaration

    Swift

    public class WebLink : BoxModel