DBPAPERListUsersOnPaperDocResponse

@interface DBPAPERListUsersOnPaperDocResponse
    : NSObject <DBSerializable, NSCopying>

The ListUsersOnPaperDocResponse struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

  • List of email addresses with their respective permission levels that are invited on the Paper doc.

    Declaration

    Objective-C

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

    Swift

    var invitees: [DBPAPERInviteeInfoWithPermissionLevel] { get }
  • List of users with their respective permission levels that are invited on the Paper folder.

    Declaration

    Objective-C

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

    Swift

    var users: [DBPAPERUserInfoWithPermissionLevel] { get }
  • The Paper doc owner. This field is populated on every single response.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBSHARINGUserInfo *_Nonnull docOwner;

    Swift

    var docOwner: DBSHARINGUserInfo { get }
  • Pass the cursor into docsUsersListContinue to paginate through all users. The cursor preserves all properties as specified in the original call to docsUsersList.

    Declaration

    Objective-C

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

    Swift

    var cursor: DBPAPERCursor { get }
  • Will be set to True if a subsequent call with the provided cursor to docsUsersListContinue returns immediately with some results. If set to False please allow some delay before making another call to docsUsersListContinue.

    Declaration

    Objective-C

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

    Swift

    var hasMore: NSNumber { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithInvitees:
        (nonnull NSArray<DBPAPERInviteeInfoWithPermissionLevel *> *)invitees
               users:(nonnull NSArray<DBPAPERUserInfoWithPermissionLevel *> *)users
            docOwner:(nonnull DBSHARINGUserInfo *)docOwner
              cursor:(nonnull DBPAPERCursor *)cursor
             hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(invitees: [DBPAPERInviteeInfoWithPermissionLevel], users: [DBPAPERUserInfoWithPermissionLevel], docOwner: DBSHARINGUserInfo, cursor: DBPAPERCursor, hasMore: NSNumber)

    Parameters

    invitees

    List of email addresses with their respective permission levels that are invited on the Paper doc.

    users

    List of users with their respective permission levels that are invited on the Paper folder.

    docOwner

    The Paper doc owner. This field is populated on every single response.

    cursor

    Pass the cursor into docsUsersListContinue to paginate through all users. The cursor preserves all properties as specified in the original call to docsUsersList.

    hasMore

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

    Return Value

    An initialized instance.