DBPAPERDocSubscriptionLevel

Objective-C

@interface DBPAPERDocSubscriptionLevel : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERDocSubscriptionLevel : NSObject, DBSerializable, NSCopying

The DocSubscriptionLevel union.

The subscription level of a Paper doc.

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 “default”.

    Description of the “default” tag state: No change email messages unless you’re the creator.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDefault_;

    Swift

    init(default_: ())

    Return Value

    An initialized instance.

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

    Description of the “ignore” tag state: Ignored: Not shown in pad lists or activity and no email message is sent.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIgnore;

    Swift

    init(ignore: ())

    Return Value

    An initialized instance.

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

    Description of the “every” tag state: Subscribed: Shown in pad lists and activity and change email messages are sent.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEvery;

    Swift

    init(every: ())

    Return Value

    An initialized instance.

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

    Description of the “no_email” tag state: Unsubscribed: Shown in pad lists, but not in activity and no change email messages are sent.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNoEmail;

    Swift

    init(noEmail: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isDefault_;

    Swift

    func isDefault_() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isIgnore;

    Swift

    func isIgnore() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isEvery;

    Swift

    func isEvery() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNoEmail;

    Swift

    func isNoEmail() -> Bool

    Return Value

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

  • 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.