DBFILESPaperUpdateArg

Objective-C

@interface DBFILESPaperUpdateArg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESPaperUpdateArg : NSObject, DBSerializable, NSCopying

The PaperUpdateArg struct.

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

Instance fields

  • Path in the user’s Dropbox to update. The path must correspond to a Paper doc or an error will be returned.

    Declaration

    Objective-C

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

    Swift

    var path: String { get }

  • The format of the provided data.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESImportFormat *_Nonnull importFormat;

    Swift

    var importFormat: DBFILESImportFormat { get }

  • How the provided content should be applied to the doc.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESPaperDocUpdatePolicy *_Nonnull docUpdatePolicy;

    Swift

    var docUpdatePolicy: DBFILESPaperDocUpdatePolicy { get }

  • The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *paperRevision;

    Swift

    var paperRevision: NSNumber? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path
                        importFormat:(nonnull DBFILESImportFormat *)importFormat
                     docUpdatePolicy:
                         (nonnull DBFILESPaperDocUpdatePolicy *)docUpdatePolicy
                       paperRevision:(nullable NSNumber *)paperRevision;

    Swift

    init(path: String, importFormat: DBFILESImportFormat, docUpdatePolicy: DBFILESPaperDocUpdatePolicy, paperRevision: NSNumber?)

    Parameters

    path

    Path in the user’s Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
    importFormat

    The format of the provided data.
    docUpdatePolicy

    How the provided content should be applied to the doc.
    paperRevision

    The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path
                        importFormat:(nonnull DBFILESImportFormat *)importFormat
                     docUpdatePolicy:
                         (nonnull DBFILESPaperDocUpdatePolicy *)docUpdatePolicy;

    Swift

    init(path: String, importFormat: DBFILESImportFormat, docUpdatePolicy: DBFILESPaperDocUpdatePolicy)

    Parameters

    path

    Path in the user’s Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
    importFormat

    The format of the provided data.
    docUpdatePolicy

    How the provided content should be applied to the doc.

    Return Value

    An initialized instance.