DBPAPERUserOnPaperDocFilter

Objective-C

@interface DBPAPERUserOnPaperDocFilter : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERUserOnPaperDocFilter : NSObject, DBSerializable, NSCopying

The UserOnPaperDocFilter 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 “visited”.

    Description of the “visited” tag state: all users who have visited the Paper doc.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithVisited;

    Swift

    init(visited: ())

    Return Value

    An initialized instance.

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

    Description of the “shared” tag state: All uses who are shared on the Paper doc. This includes all users who have visited the Paper doc as well as those who have not.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithShared;

    Swift

    init(shared: ())

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

    Declaration

    Objective-C

    - (BOOL)isVisited;

    Swift

    func isVisited() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isShared;

    Swift

    func isShared() -> Bool

    Return Value

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

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