DBPAPERListUsersOnPaperDocArgs

Objective-C

@interface DBPAPERListUsersOnPaperDocArgs
    : DBPAPERRefPaperDoc <DBSerializable, NSCopying>

Swift

class DBPAPERListUsersOnPaperDocArgs : DBPAPERRefPaperDoc, DBSerializable, NSCopying

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

  • Size limit per batch. The maximum number of users 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 }

  • Specify this attribute if you want to obtain users that have already accessed the Paper doc.

    Declaration

    Objective-C

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

    Swift

    var filterBy: DBPAPERUserOnPaperDocFilter { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocId:(nonnull NSString *)docId
                                limit:(nullable NSNumber *)limit
                             filterBy:(nullable DBPAPERUserOnPaperDocFilter *)
                                          filterBy;

    Swift

    init(docId: String, limit: NSNumber?, filterBy: DBPAPERUserOnPaperDocFilter?)

    Parameters

    docId

    The Paper doc ID.
    limit

    Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
    filterBy

    Specify this attribute if you want to obtain users that have already accessed the Paper doc.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDocId:(nonnull NSString *)docId;

    Swift

    init(docId: String)

    Parameters

    docId

    The Paper doc ID.

    Return Value

    An initialized instance.