DBSHARINGSharedFileMembers
Objective-C
@interface DBSHARINGSharedFileMembers : NSObject <DBSerializable, NSCopying>
Swift
class DBSHARINGSharedFileMembers : NSObject, DBSerializable, NSCopying
The SharedFileMembers
struct.
Shared file user, group, and invitee membership. Used for the results of
listFileMembers
and listFileMembersContinue
, and used as part of the
results for listFileMembersBatch
.
This class implements the DBSerializable
protocol (serialize and
deserialize instance methods), which is required for all Obj-C SDK API route
objects.
-
The list of user members of the shared file.
Declaration
Objective-C
@property (nonatomic, readonly) NSArray<DBSHARINGUserFileMembershipInfo *> *_Nonnull users;
Swift
var users: [DBSHARINGUserFileMembershipInfo] { get }
-
The list of group members of the shared file.
Declaration
Objective-C
@property (nonatomic, readonly) NSArray<DBSHARINGGroupMembershipInfo *> *_Nonnull groups;
Swift
var groups: [DBSHARINGGroupMembershipInfo] { get }
-
The list of invited members of a file, but have not logged in and claimed this.
Declaration
Objective-C
@property (nonatomic, readonly) NSArray<DBSHARINGInviteeMembershipInfo *> *_Nonnull invitees;
Swift
var invitees: [DBSHARINGInviteeMembershipInfo] { get }
-
Present if there are additional shared file members that have not been returned yet. Pass the cursor into
listFileMembersContinue
to list additional members.Declaration
Objective-C
@property (nonatomic, copy, readonly, nullable) NSString *cursor;
Swift
var cursor: String? { get }
-
Full constructor for the struct (exposes all instance variables).
Declaration
Objective-C
- (nonnull instancetype) initWithUsers:(nonnull NSArray<DBSHARINGUserFileMembershipInfo *> *)users groups:(nonnull NSArray<DBSHARINGGroupMembershipInfo *> *)groups invitees:(nonnull NSArray<DBSHARINGInviteeMembershipInfo *> *)invitees cursor:(nullable NSString *)cursor;
Swift
init(users: [DBSHARINGUserFileMembershipInfo], groups: [DBSHARINGGroupMembershipInfo], invitees: [DBSHARINGInviteeMembershipInfo], cursor: String?)
Parameters
users
The list of user members of the shared file.
groups
The list of group members of the shared file.
invitees
The list of invited members of a file, but have not logged in and claimed this.
cursor
Present if there are additional shared file members that have not been returned yet. Pass the cursor into
listFileMembersContinue
to list additional members.Return Value
An initialized instance.
-
Convenience constructor (exposes only non-nullable instance variables with no default value).
Declaration
Objective-C
- (nonnull instancetype) initWithUsers:(nonnull NSArray<DBSHARINGUserFileMembershipInfo *> *)users groups:(nonnull NSArray<DBSHARINGGroupMembershipInfo *> *)groups invitees:(nonnull NSArray<DBSHARINGInviteeMembershipInfo *> *)invitees;
Swift
init(users: [DBSHARINGUserFileMembershipInfo], groups: [DBSHARINGGroupMembershipInfo], invitees: [DBSHARINGInviteeMembershipInfo])
Parameters
users
The list of user members of the shared file.
groups
The list of group members of the shared file.
invitees
The list of invited members of a file, but have not logged in and claimed this.
Return Value
An initialized instance.