DBPAPERListUsersOnFolderArgs

Objective-C

@interface DBPAPERListUsersOnFolderArgs
    : DBPAPERRefPaperDoc <DBSerializable, NSCopying>

Swift

class DBPAPERListUsersOnFolderArgs : DBPAPERRefPaperDoc, DBSerializable, NSCopying

The ListUsersOnFolderArgs 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 }

Constructors

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

    Declaration

    Objective-C

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

    Swift

    init(docId: String, limit: NSNumber?)

    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.

    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.