com.dropbox.core.v2.sharing

Class InviteeMembershipInfo

java.lang.Object

com.dropbox.core.v2.sharing.MembershipInfo

com.dropbox.core.v2.sharing.InviteeMembershipInfo

public class InviteeMembershipInfo
extends MembershipInfo

Information about an invited member of a shared content.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected InviteeInfo	invitee
protected UserInfo	user

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

accessType, initials, isInherited, permissions

Constructor Summary

Constructors

Constructor and Description
InviteeMembershipInfo(AccessLevel accessType, InviteeInfo invitee) Information about an invited member of a shared content.
InviteeMembershipInfo(AccessLevel accessType, InviteeInfo invitee, List<MemberPermission> permissions, String initials, boolean isInherited, UserInfo user) Information about an invited member of a shared content.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AccessLevel	getAccessType() The access type for this member.
String	getInitials() Suggested name initials for a member.
InviteeInfo	getInvitee() Recipient of the invitation.
boolean	getIsInherited() True if the member has access from a parent folder.
List<MemberPermission>	getPermissions() The permissions that requesting user has on this member.
UserInfo	getUser() The user this invitation is tied to, if available.
int	hashCode()
static InviteeMembershipInfo.Builder	newBuilder(AccessLevel accessType, InviteeInfo invitee) Returns a new builder for creating an instance of this class.
String	toString()
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

invitee

protected final InviteeInfo invitee

user

protected final UserInfo user

Constructor Detail

InviteeMembershipInfo

public InviteeMembershipInfo(AccessLevel accessType,
                             InviteeInfo invitee,
                             List<MemberPermission> permissions,
                             String initials,
                             boolean isInherited,
                             UserInfo user)

Information about an invited member of a 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. Must not be null.

invitee - Recipient of the invitation. 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 - Suggested name initials for a member.

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

user - The user this invitation is tied to, if available.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

InviteeMembershipInfo

public InviteeMembershipInfo(AccessLevel accessType,
                             InviteeInfo invitee)

Information about an invited member of a shared content.

The default values for unset fields will be used.

Parameters:

accessType - The access type for this member. Must not be null.

invitee - Recipient of the invitation. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getAccessType

public AccessLevel getAccessType()

The access type for this member.

Overrides:

getAccessType in class MembershipInfo

Returns:

value for this field, never null.

getInvitee

public InviteeInfo getInvitee()

Recipient of the invitation.

Returns:

value for this field, never null.

getPermissions

public 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 String getInitials()

Suggested name initials for a member.

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.

getUser

public UserInfo getUser()

The user this invitation is tied to, if available.

Returns:

value for this field, or null if not present.

newBuilder

public static InviteeMembershipInfo.Builder newBuilder(AccessLevel accessType,
                                                       InviteeInfo invitee)

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

Parameters:

accessType - The access type for this member. Must not be null.

invitee - Recipient of the invitation. Must not be null.

Returns:

builder for this class.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class MembershipInfo

equals

public boolean equals(Object obj)

Overrides:

equals in class MembershipInfo

toString

public String toString()

Overrides:

toString in class MembershipInfo

toStringMultiline

public 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