com.dropbox.core.v2.sharing

Class UserMembershipInfo

java.lang.Object

com.dropbox.core.v2.sharing.MembershipInfo

com.dropbox.core.v2.sharing.UserMembershipInfo

Direct Known Subclasses:

UserFileMembershipInfo

public class UserMembershipInfo
extends MembershipInfo

The information about a user member of the shared content.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserMembershipInfo.Builder Builder for UserMembershipInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected UserInfo	user

Fields inherited from class com.dropbox.core.v2.sharing.MembershipInfo

accessType, initials, isInherited, permissions

Constructor Summary

Constructors

Constructor and Description
UserMembershipInfo(AccessLevel accessType, UserInfo user) The information about a user member of the shared content.
UserMembershipInfo(AccessLevel accessType, UserInfo user, java.util.List<MemberPermission> permissions, java.lang.String initials, boolean isInherited) The information about a user member of the shared content.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
AccessLevel	getAccessType() The access type for this member.
java.lang.String	getInitials() Never set.
boolean	getIsInherited() True if the member has access from a parent folder.
java.util.List<MemberPermission>	getPermissions() The permissions that requesting user has on this member.
UserInfo	getUser() The account information for the membership user.
int	hashCode()
static UserMembershipInfo.Builder	newBuilder(AccessLevel accessType, UserInfo user) Returns a new builder for creating an instance of this class.
java.lang.String	toString()
java.lang.String	toStringMultiline() Returns a String representation of this object formatted for easier readability.

Methods inherited from class com.dropbox.core.v2.sharing.MembershipInfo

newBuilder

Methods inherited from class java.lang.Object

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

Field Detail

user

protected final UserInfo user

Constructor Detail

UserMembershipInfo

public UserMembershipInfo(AccessLevel accessType,
                          UserInfo user,
                          java.util.List<MemberPermission> permissions,
                          java.lang.String initials,
                          boolean isInherited)

The information about a user member of the shared content.

Use newBuilder to create instances of this class without specifying values for all optional fields.

Parameters:

accessType - The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.

user - The account information for the membership user. Must not be null.

permissions - The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. Must not contain a null item.

initials - Never set.

isInherited - True if the member has access from a parent folder.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

UserMembershipInfo

public UserMembershipInfo(AccessLevel accessType,
                          UserInfo user)

The information about a user member of the shared content.

The default values for unset fields will be used.

Parameters:

accessType - The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.

user - The account information for the membership user. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getAccessType

public AccessLevel getAccessType()

The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.

Overrides:

getAccessType in class MembershipInfo

Returns:

value for this field, never null.

getUser

public UserInfo getUser()

The account information for the membership user.

Returns:

value for this field, never null.

getPermissions

public java.util.List<MemberPermission> getPermissions()

The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.

Overrides:

getPermissions in class MembershipInfo

Returns:

value for this field, or null if not present.

getInitials

public java.lang.String getInitials()

Never set.

Overrides:

getInitials in class MembershipInfo

Returns:

value for this field, or null if not present.

getIsInherited

public boolean getIsInherited()

True if the member has access from a parent folder.

Overrides:

getIsInherited in class MembershipInfo

Returns:

value for this field, or null if not present. Defaults to false.

newBuilder

public static UserMembershipInfo.Builder newBuilder(AccessLevel accessType,
                                                    UserInfo user)

Returns a new builder for creating an instance of this class.

Parameters:

accessType - The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.

user - The account information for the membership user. Must not be null.

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class MembershipInfo

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class MembershipInfo

toString

public java.lang.String toString()

Overrides:

toString in class MembershipInfo

toStringMultiline

public java.lang.String toStringMultiline()

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

The returned String may contain newlines.

Overrides:

toStringMultiline in class MembershipInfo

Returns:

Formatted, multiline String representation of this object