Folder

public class Folder : BoxModel

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

BoxModel

  • Box item type

    Declaration

    Swift

    public var type: String

  • Declaration

    Swift

    public private(set) var rawData: [String : Any] { get }

Properties

  • id

    Identifier

    Declaration

    Swift

    public let id: String

  • A unique ID for use with the events.

    Declaration

    Swift

    public let sequenceId: String?

  • The entity tag of this folder. Used with If-Match headers.

    Declaration

    Swift

    public let etag: String?

  • The name of the folder.

    Declaration

    Swift

    public let name: String?

  • The time the folder was created.

    Declaration

    Swift

    public let createdAt: Date?

  • When this folder was last updated on the Box servers.

    Declaration

    Swift

    public let modifiedAt: Date?

  • The description of the folder. The limit is 256 characters.

    Declaration

    Swift

    public let description: String?

  • Whether future collaborations should be restricted to within the enterprise only

    Declaration

    Swift

    public let isCollaborationRestrictedToEnterprise: Bool?

  • The folder size in bytes.

    Declaration

    Swift

    public let size: Int?

  • The path of folders to this folder, starting at the root.

    Declaration

    Swift

    public let pathCollection: PathCollection?

  • The user who created this folder.

    Declaration

    Swift

    public let createdBy: User?

  • The user who last modified this folder.

    Declaration

    Swift

    public let modifiedBy: User?

  • The user who owns this folder.

    Declaration

    Swift

    public let ownedBy: User?

  • The shared link object for this file. Is nil if no shared link has been created.

    Declaration

    Swift

    public let sharedLink: SharedLink?

  • The upload email address for this folder.

    Declaration

    Swift

    public let folderUploadEmail: FolderUploadEmail?

  • The folder that contains this folder. May be nil for folders such as root, trash and child folders whose parent is inaccessible.

    Declaration

    Swift

    public let parent: Folder?

  • Whether this item is deleted or not.

    Declaration

    Swift

    public let itemStatus: ItemStatus?

  • The time the folder or its contents were originally created (according to the uploader). May be nil for some folders such as root or trash.

    Declaration

    Swift

    public let contentCreatedAt: Date?

  • The time the folder or its contents were last modified (according to the uploader). May be nil for some folders such as root or trash.

    Declaration

    Swift

    public let contentModifiedAt: Date?

  • Whether non-owners can invite collaborators to this folder.

    Declaration

    Swift

    public let canNonOwnersInvite: Bool?

  • The time the folder or its contents were put in the trash.

    Declaration

    Swift

    public let trashedAt: Date?

  • The time the folder or its contents will be purged from the trash.

    Declaration

    Swift

    public let purgedAt: Date?

  • Whether this folder will be synced by the Box sync clients or not.

    Declaration

    Swift

    public let syncState: SyncState?

  • Whether this folder has any collaborators.

    Declaration

    Swift

    public let hasCollaborations: Bool?

  • An object containing the permissions that the current user has on this folder.

    Declaration

    Swift

    public let permissions: Permissions?

  • All tags applied to this folder.

    Declaration

    Swift

    public let tags: [String]?

  • Access level settings for shared links set by administrator.

    Declaration

    Swift

    public let allowedSharedLinkAccessLevels: [SharedLinkAccess]?

  • Folder collaboration roles allowed by the enterprise administrator.

    Declaration

    Swift

    public let allowedInviteeRoles: [String]?

  • Whether this folder is owned by a user outside of the enterprise.

    Declaration

    Swift

    public let isExternallyOwned: Bool?

  • The collections the folder belongs to

    Declaration

    Swift

    public let collections: [[String : String]]?

  • Details about the classification applied to a Box folder

    Declaration

    Swift

    public let classification: Classification?

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

    public required init(json: [String : Any]) throws

    Parameters

    json

    JSON dictionary.