DBPAPERListPaperDocsFilterBy

Objective-C

@interface DBPAPERListPaperDocsFilterBy : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERListPaperDocsFilterBy : NSObject, DBSerializable, NSCopying

The ListPaperDocsFilterBy 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 “docs_accessed”.

    Description of the “docs_accessed” tag state: Fetches all Paper doc IDs that the user has ever accessed.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocsAccessed;

    Swift

    init(docsAccessed: ())

    Return Value

    An initialized instance.

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

    Description of the “docs_created” tag state: Fetches only the Paper doc IDs that the user has created.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocsCreated;

    Swift

    init(docsCreated: ())

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

    Declaration

    Objective-C

    - (BOOL)isDocsAccessed;

    Swift

    func isDocsAccessed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDocsCreated;

    Swift

    func isDocsCreated() -> Bool

    Return Value

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

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