DBPAPERPaperDocUpdatePolicy

Objective-C

@interface DBPAPERPaperDocUpdatePolicy : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERPaperDocUpdatePolicy : NSObject, DBSerializable, NSCopying

The PaperDocUpdatePolicy union.

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

Instance fields

Constructors

  • Initializes union class with tag state of “append”.

    Description of the “append” tag state: The content will be appended to the doc.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAppend;

    Swift

    init(append: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “prepend”.

    Description of the “prepend” tag state: The content will be prepended to the doc. The doc title will not be affected.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPrepend;

    Swift

    init(prepend: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “overwrite_all”.

    Description of the “overwrite_all” tag state: The document will be overwitten at the head with the provided content.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOverwriteAll;

    Swift

    init(overwriteAll: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “append”.

    Declaration

    Objective-C

    - (BOOL)isAppend;

    Swift

    func isAppend() -> Bool

    Return Value

    Whether the union’s current tag state has value “append”.

  • Retrieves whether the union’s current tag state has value “prepend”.

    Declaration

    Objective-C

    - (BOOL)isPrepend;

    Swift

    func isPrepend() -> Bool

    Return Value

    Whether the union’s current tag state has value “prepend”.

  • Retrieves whether the union’s current tag state has value “overwrite_all”.

    Declaration

    Objective-C

    - (BOOL)isOverwriteAll;

    Swift

    func isOverwriteAll() -> Bool

    Return Value

    Whether the union’s current tag state has value “overwrite_all”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.