DBFILEREQUESTSFileRequest

Objective-C

@interface DBFILEREQUESTSFileRequest : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEREQUESTSFileRequest : NSObject, DBSerializable, NSCopying

The FileRequest struct.

A file request https://www.dropbox.com/help/9090 for receiving files into the user’s Dropbox account.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • id_

    The ID of the file request.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull id_;

    Swift

    var id_: String { get }
  • url

    The URL of the file request.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull url;

    Swift

    var url: String { get }

  • The title of the file request.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull title;

    Swift

    var title: String { get }

  • The path of the folder in the Dropbox where uploaded files will be sent. This can be null if the destination was removed. For apps with the app folder permission, this will be relative to the app folder.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *destination;

    Swift

    var destination: String? { get }

  • When this file request was created.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull created;

    Swift

    var created: Date { get }

  • The deadline for this file request. Only set if the request has a deadline.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBFILEREQUESTSFileRequestDeadline *deadline;

    Swift

    var deadline: DBFILEREQUESTSFileRequestDeadline? { get }

  • Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull isOpen;

    Swift

    var isOpen: NSNumber { get }

  • The number of files this file request has received.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull fileCount;

    Swift

    var fileCount: NSNumber { get }

  • A description of the file request.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *description_;

    Swift

    var description_: String? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
     initWithId_:(nonnull NSString *)id_
             url:(nonnull NSString *)url
           title:(nonnull NSString *)title
         created:(nonnull NSDate *)created
          isOpen:(nonnull NSNumber *)isOpen
       fileCount:(nonnull NSNumber *)fileCount
     destination:(nullable NSString *)destination
        deadline:(nullable DBFILEREQUESTSFileRequestDeadline *)deadline
    description_:(nullable NSString *)description_;

    Swift

    init(id_: String, url: String, title: String, created: Date, isOpen: NSNumber, fileCount: NSNumber, destination: String?, deadline: DBFILEREQUESTSFileRequestDeadline?, description_: String?)

    Parameters

    id_

    The ID of the file request.
    url

    The URL of the file request.
    title

    The title of the file request.
    created

    When this file request was created.
    isOpen

    Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.
    fileCount

    The number of files this file request has received.
    destination

    The path of the folder in the Dropbox where uploaded files will be sent. This can be null if the destination was removed. For apps with the app folder permission, this will be relative to the app folder.
    deadline

    The deadline for this file request. Only set if the request has a deadline.
    description_

    A description of the file request.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithId_:(nonnull NSString *)id_
                                url:(nonnull NSString *)url
                              title:(nonnull NSString *)title
                            created:(nonnull NSDate *)created
                             isOpen:(nonnull NSNumber *)isOpen
                          fileCount:(nonnull NSNumber *)fileCount;

    Swift

    init(id_: String, url: String, title: String, created: Date, isOpen: NSNumber, fileCount: NSNumber)

    Parameters

    id_

    The ID of the file request.
    url

    The URL of the file request.
    title

    The title of the file request.
    created

    When this file request was created.
    isOpen

    Whether or not the file request is open. If the file request is closed, it will not accept any more file submissions.
    fileCount

    The number of files this file request has received.

    Return Value

    An initialized instance.