DBPAPERListPaperDocsArgs

Objective-C

@interface DBPAPERListPaperDocsArgs : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERListPaperDocsArgs : NSObject, DBSerializable, NSCopying

The ListPaperDocsArgs 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


                    
                    
                    filterBy

Allows user to specify how the Paper docs should be filtered.

Declaration

Objective-C

@property (nonatomic, readonly) DBPAPERListPaperDocsFilterBy *_Nonnull filterBy;

Swift

var filterBy: DBPAPERListPaperDocsFilterBy { get }


                    
                    
                    sortBy

Allows user to specify how the Paper docs should be sorted.

Declaration

Objective-C

@property (nonatomic, readonly) DBPAPERListPaperDocsSortBy *_Nonnull sortBy;

Swift

var sortBy: DBPAPERListPaperDocsSortBy { get }


                    
                    
                    sortOrder

Allows user to specify the sort order of the result.

Declaration

Objective-C

@property (nonatomic, readonly) DBPAPERListPaperDocsSortOrder *_Nonnull sortOrder;

Swift

var sortOrder: DBPAPERListPaperDocsSortOrder { get }

limit
Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
Declaration
Objective-C

@property (nonatomic, readonly) NSNumber *_Nonnull limit;
Swift

var limit: NSNumber { get }

Constructors


                    
                    
                    -initWithFilterBy:sortBy:sortOrder:limit:

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

Declaration

Objective-C

- (nonnull instancetype)
    initWithFilterBy:(nullable DBPAPERListPaperDocsFilterBy *)filterBy
              sortBy:(nullable DBPAPERListPaperDocsSortBy *)sortBy
           sortOrder:(nullable DBPAPERListPaperDocsSortOrder *)sortOrder
               limit:(nullable NSNumber *)limit;

Swift

init(filterBy: DBPAPERListPaperDocsFilterBy?, sortBy: DBPAPERListPaperDocsSortBy?, sortOrder: DBPAPERListPaperDocsSortOrder?, limit: NSNumber?)

Parameters

`filterBy`	Allows user to specify how the Paper docs should be filtered.
`sortBy`	Allows user to specify how the Paper docs should be sorted.
`sortOrder`	Allows user to specify the sort order of the result.
`limit`	Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

Return Value

An initialized instance.

-initDefault
Convenience constructor (exposes only non-nullable instance variables with no default value).
Declaration
Objective-C

- (nonnull instancetype)initDefault;
Swift

init(default: ())
Return Value

An initialized instance.