DBPAPERListUsersOnFolderResponse

Objective-C

@interface DBPAPERListUsersOnFolderResponse
    : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERListUsersOnFolderResponse : NSObject, DBSerializable, NSCopying

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

  • List of email addresses that are invited on the Paper folder.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBSHARINGInviteeInfo *> *_Nonnull invitees;

    Swift

    var invitees: [DBSHARINGInviteeInfo] { get }

  • List of users that are invited on the Paper folder.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBSHARINGUserInfo *> *_Nonnull users;

    Swift

    var users: [DBSHARINGUserInfo] { get }

  • Pass the cursor into docsFolderUsersListContinue to paginate through all users. The cursor preserves all properties as specified in the original call to docsFolderUsersList.

    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 docsFolderUsersListContinue returns immediately with some results. If set to False please allow some delay before making another call to docsFolderUsersListContinue.

    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)
    initWithInvitees:(nonnull NSArray<DBSHARINGInviteeInfo *> *)invitees
               users:(nonnull NSArray<DBSHARINGUserInfo *> *)users
              cursor:(nonnull DBPAPERCursor *)cursor
             hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(invitees: [DBSHARINGInviteeInfo], users: [DBSHARINGUserInfo], cursor: DBPAPERCursor, hasMore: NSNumber)

    Parameters

    invitees

    List of email addresses that are invited on the Paper folder.
    users

    List of users that are invited on the Paper folder.
    cursor

    Pass the cursor into docsFolderUsersListContinue to paginate through all users. The cursor preserves all properties as specified in the original call to docsFolderUsersList.
    hasMore

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

    Return Value

    An initialized instance.