DBFILEREQUESTSCreateFileRequestArgs

Objective-C

@interface DBFILEREQUESTSCreateFileRequestArgs
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEREQUESTSCreateFileRequestArgs : NSObject, DBSerializable, NSCopying

The CreateFileRequestArgs struct.

Arguments for create.

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

Instance fields

  • The title of the file request. Must not be empty.

    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. For apps with the app folder permission, this will be relative to the app folder.

    Declaration

    Objective-C

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

    Swift

    var destination: String { get }

  • The deadline for the file request. Deadlines can only be set by Professional and Business accounts.

    Declaration

    Objective-C

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

    Swift

    var deadline: DBFILEREQUESTSFileRequestDeadline? { get }

  • Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.

    Declaration

    Objective-C

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

    Swift

    var open: 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)
    initWithTitle:(nonnull NSString *)title
      destination:(nonnull NSString *)destination
         deadline:(nullable DBFILEREQUESTSFileRequestDeadline *)deadline
             open:(nullable NSNumber *)open
     description_:(nullable NSString *)description_;

    Swift

    init(title: String, destination: String, deadline: DBFILEREQUESTSFileRequestDeadline?, open: NSNumber?, description_: String?)

    Parameters

    title

    The title of the file request. Must not be empty.
    destination

    The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
    deadline

    The deadline for the file request. Deadlines can only be set by Professional and Business accounts.
    open

    Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.
    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)initWithTitle:(nonnull NSString *)title
                          destination:(nonnull NSString *)destination;

    Swift

    init(title: String, destination: String)

    Parameters

    title

    The title of the file request. Must not be empty.
    destination

    The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.

    Return Value

    An initialized instance.