Package com.dropbox.core.v2.sharing

Class SharedFileMembers

java.lang.Object

com.dropbox.core.v2.sharing.SharedFileMembers

public class SharedFileMembers
extends Object

Shared file user, group, and invitee membership. Used for the results of DbxUserSharingRequests.listFileMembers(String) and DbxUserSharingRequests.listFileMembersContinue(String), and used as part of the results for DbxUserSharingRequests.listFileMembersBatch(List,long).

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	cursor
protected final List<GroupMembershipInfo>	groups
protected final List<InviteeMembershipInfo>	invitees
protected final List<UserFileMembershipInfo>	users

Constructor Summary

Constructors

Constructor	Description
SharedFileMembers(List<UserFileMembershipInfo> users, List<GroupMembershipInfo> groups, List<InviteeMembershipInfo> invitees)	Shared file user, group, and invitee membership.
SharedFileMembers(List<UserFileMembershipInfo> users, List<GroupMembershipInfo> groups, List<InviteeMembershipInfo> invitees, String cursor)	Shared file user, group, and invitee membership.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCursor()	Present if there are additional shared file members that have not been returned yet.
List<GroupMembershipInfo>	getGroups()	The list of group members of the shared file.
List<InviteeMembershipInfo>	getInvitees()	The list of invited members of a file, but have not logged in and claimed this.
List<UserFileMembershipInfo>	getUsers()	The list of user members of the shared file.
int	hashCode()
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

users

@Nonnull
protected final List<UserFileMembershipInfo> users

groups

@Nonnull
protected final List<GroupMembershipInfo> groups

invitees

@Nonnull
protected final List<InviteeMembershipInfo> invitees

cursor

@Nullable
protected final String cursor

Constructor Details

SharedFileMembers

public SharedFileMembers(@Nonnull
 List<UserFileMembershipInfo> users,
 @Nonnull
 List<GroupMembershipInfo> groups,
 @Nonnull
 List<InviteeMembershipInfo> invitees,
 @Nullable
 String cursor)

Shared file user, group, and invitee membership. Used for the results of DbxUserSharingRequests.listFileMembers(String) and DbxUserSharingRequests.listFileMembersContinue(String), and used as part of the results for DbxUserSharingRequests.listFileMembersBatch(List,long).

Parameters:

users - The list of user members of the shared file. Must not contain a null item and not be null.

groups - The list of group members of the shared file. Must not contain a null item and not be null.

invitees - The list of invited members of a file, but have not logged in and claimed this. Must not contain a null item and not be null.

cursor - Present if there are additional shared file members that have not been returned yet. Pass the cursor into DbxUserSharingRequests.listFileMembersContinue(String) to list additional members.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

SharedFileMembers

public SharedFileMembers(@Nonnull
 List<UserFileMembershipInfo> users,
 @Nonnull
 List<GroupMembershipInfo> groups,
 @Nonnull
 List<InviteeMembershipInfo> invitees)

Shared file user, group, and invitee membership. Used for the results of DbxUserSharingRequests.listFileMembers(String) and DbxUserSharingRequests.listFileMembersContinue(String), and used as part of the results for DbxUserSharingRequests.listFileMembersBatch(List,long).

The default values for unset fields will be used.

Parameters:

users - The list of user members of the shared file. Must not contain a null item and not be null.

groups - The list of group members of the shared file. Must not contain a null item and not be null.

invitees - The list of invited members of a file, but have not logged in and claimed this. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getUsers

@Nonnull
public List<UserFileMembershipInfo> getUsers()

The list of user members of the shared file.

Returns:

value for this field, never null.

getGroups

@Nonnull
public List<GroupMembershipInfo> getGroups()

The list of group members of the shared file.

Returns:

value for this field, never null.

getInvitees

@Nonnull
public List<InviteeMembershipInfo> getInvitees()

The list of invited members of a file, but have not logged in and claimed this.

Returns:

value for this field, never null.

getCursor

@Nullable
public String getCursor()

Present if there are additional shared file members that have not been returned yet. Pass the cursor into DbxUserSharingRequests.listFileMembersContinue(String) to list additional members.

Returns:

value for this field, or null if not present.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object