DBPAPERListPaperDocsResponse

Objective-C

@interface DBPAPERListPaperDocsResponse : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERListPaperDocsResponse : NSObject, DBSerializable, NSCopying

The ListPaperDocsResponse 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 list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to docsList.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull docIds;

    Swift

    var docIds: [String] { get }

  • Pass the cursor into docsListContinue to paginate through all files. The cursor preserves all properties as specified in the original call to docsList.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBPAPERCursor *_Nonnull cursor;

    Swift

    var cursor: DBPAPERCursor { get }

  • Will be set to True if a subsequent call with the provided cursor to docsListContinue returns immediately with some results. If set to False please allow some delay before making another call to docsListContinue.

    Declaration

    Objective-C

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

    Swift

    var hasMore: NSNumber { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocIds:(nonnull NSArray<NSString *> *)docIds
                                cursor:(nonnull DBPAPERCursor *)cursor
                               hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(docIds: [String], cursor: DBPAPERCursor, hasMore: NSNumber)

    Parameters

    docIds

    The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to docsList.
    cursor

    Pass the cursor into docsListContinue to paginate through all files. The cursor preserves all properties as specified in the original call to docsList.
    hasMore

    Will be set to True if a subsequent call with the provided cursor to docsListContinue returns immediately with some results. If set to False please allow some delay before making another call to docsListContinue.

    Return Value

    An initialized instance.