DBPAPERPaperDocUpdateArgs

Objective-C

@interface DBPAPERPaperDocUpdateArgs
    : DBPAPERRefPaperDoc <DBSerializable, NSCopying>

Swift

class DBPAPERPaperDocUpdateArgs : DBPAPERRefPaperDoc, DBSerializable, NSCopying

The PaperDocUpdateArgs 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

  • The policy used for the current update call.

    Declaration

    Objective-C

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

    Swift

    var docUpdatePolicy: DBPAPERPaperDocUpdatePolicy { get }

  • The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.

    Declaration

    Objective-C

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

    Swift

    var revision: NSNumber { get }

  • The format of provided data.

    Declaration

    Objective-C

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

    Swift

    var importFormat: DBPAPERImportFormat { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
      initWithDocId:(nonnull NSString *)docId
    docUpdatePolicy:(nonnull DBPAPERPaperDocUpdatePolicy *)docUpdatePolicy
           revision:(nonnull NSNumber *)revision
       importFormat:(nonnull DBPAPERImportFormat *)importFormat;

    Swift

    init(docId: String, docUpdatePolicy: DBPAPERPaperDocUpdatePolicy, revision: NSNumber, importFormat: DBPAPERImportFormat)

    Parameters

    docId

    The Paper doc ID.
    docUpdatePolicy

    The policy used for the current update call.
    revision

    The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.
    importFormat

    The format of provided data.

    Return Value

    An initialized instance.