FileRequest

public final class FileRequest : BoxModel

Undocumented

BoxModel

  • Box item type

    Declaration

    Swift

    public var type: String

  • Declaration

    Swift

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

Properties

  • id

    The unique identifier for this file request.

    Declaration

    Swift

    public let id: String

  • The title of file request. This is shown in the Box UI to users uploading files.

    Declaration

    Swift

    public let title: String?

  • The optional description of this file request. This is shown in the Box UI to users uploading files.

    Declaration

    Swift

    public let description: String?

  • The status of the file request.

    Declaration

    Swift

    public let status: FileRequestStatus?

  • Whether a file request submitter is required to provide their email address. When this setting is set to true, the Box UI will show an email field on the file request form.

    Declaration

    Swift

    public let isEmailRequired: Bool?

  • Whether a file request submitter is required to provide a description of the files they are submitting. When this setting is set to true, the Box UI will show a description field on the file request form.

    Declaration

    Swift

    public let isDescriptionRequired: Bool?

  • The date after which a file request will no longer accept new submissions. After this date, the status will automatically be set to inactive.

    Declaration

    Swift

    public let expiresAt: Date?

  • The folder that this file request is associated with. Files submitted through the file request form will be uploaded to this folder.

    Declaration

    Swift

    public let folder: Folder
  • url

    The generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder.

    Declaration

    Swift

    public let url: String?

  • The HTTP etag of this file. This can be used in combination with the If-Match header when updating a file request. By providing that header, a change will only be performed on the file request if the etag on the file request still matches the etag provided in the If-Match header.

    Declaration

    Swift

    public let etag: String?

  • The user who created this file request.

    Declaration

    Swift

    public let createdBy: User?

  • The date and time when the file request was created.

    Declaration

    Swift

    public let createdAt: Date

  • The user who last modified this file request.

    Declaration

    Swift

    public let updatedBy: User?

  • The date and time when the file request was last updated.

    Declaration

    Swift

    public let updatedAt: Date

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

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

    Parameters

    json

    JSON dictionary.