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.
  • Field Details

    • invitee

      @Nonnull protected final InviteeInfo invitee
    • user

      @Nullable protected final UserInfo user
  • Constructor Details

    • InviteeMembershipInfo

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

      Use newBuilder(com.dropbox.core.v2.sharing.AccessLevel,com.dropbox.core.v2.sharing.InviteeInfo) 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.
      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 - Field is deprecated. Never set.
      isInherited - True if the member has access on 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(@Nonnull AccessLevel accessType, @Nonnull 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. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.
      invitee - Recipient of the invitation. Must not be null.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.
  • Method Details

    • getAccessType

      @Nonnull 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.
    • getInvitee

      @Nonnull public InviteeInfo getInvitee()
      Recipient of the invitation.
      Returns:
      value for this field, never null.
    • getPermissions

      @Nullable 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

      @Deprecated @Nullable public String getInitials()
      Deprecated.
      Field is deprecated. 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 on a parent folder.
      Overrides:
      getIsInherited in class MembershipInfo
      Returns:
      value for this field, or null if not present. Defaults to false.
    • getUser

      @Nullable 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. It contains inherited access type from parent folder, and acquired access type from this folder. 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