Package com.dropbox.core.v2.team

Class MemberAddArgBase

java.lang.Object
com.dropbox.core.v2.team.MemberAddArgBase
Direct Known Subclasses:
MemberAddArg, MemberAddV2Arg
public class MemberAddArgBase extends Object

  • Field Details

    • memberEmail

      @Nonnull protected final String memberEmail

    • memberGivenName

      @Nullable protected final String memberGivenName

    • memberSurname

      @Nullable protected final String memberSurname

    • memberExternalId

      @Nullable protected final String memberExternalId

    • memberPersistentId

      @Nullable protected final String memberPersistentId

    • sendWelcomeEmail

      protected final boolean sendWelcomeEmail

    • isDirectoryRestricted

      @Nullable protected final Boolean isDirectoryRestricted

  • Constructor Details

    • MemberAddArgBase

      public MemberAddArgBase(@Nonnull String memberEmail, @Nullable String memberGivenName, @Nullable String memberSurname, @Nullable String memberExternalId, @Nullable String memberPersistentId, boolean sendWelcomeEmail, @Nullable Boolean isDirectoryRestricted)
      Use newBuilder(java.lang.String) to create instances of this class without specifying values for all optional fields.
      Parameters:
      memberEmail - Must have length of at most 255, match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", and not be null.
      memberGivenName - Member's first name. Must have length of at most 50 and match pattern "[^/:?*<>\"|]*".
      memberSurname - Member's last name. Must have length of at most 50 and match pattern "[^/:?*<>\"|]*".
      memberExternalId - External ID for member. Must have length of at most 64.
      memberPersistentId - Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
      sendWelcomeEmail - Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.
      isDirectoryRestricted - Whether a user is directory restricted.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • MemberAddArgBase

      public MemberAddArgBase(@Nonnull String memberEmail)
      None

      The default values for unset fields will be used.

      Parameters:
      memberEmail - Must have length of at most 255, match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", and not be null.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

  • Method Details

    • getMemberEmail

      @Nonnull public String getMemberEmail()
      Returns:
      value for this field, never null.

    • getMemberGivenName

      @Nullable public String getMemberGivenName()
      Member's first name.
      Returns:
      value for this field, or null if not present.

    • getMemberSurname

      @Nullable public String getMemberSurname()
      Member's last name.
      Returns:
      value for this field, or null if not present.

    • getMemberExternalId

      @Nullable public String getMemberExternalId()
      External ID for member.
      Returns:
      value for this field, or null if not present.

    • getMemberPersistentId

      @Nullable public String getMemberPersistentId()
      Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
      Returns:
      value for this field, or null if not present.

    • getSendWelcomeEmail

      public boolean getSendWelcomeEmail()
      Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.
      Returns:
      value for this field, or null if not present. Defaults to true.

    • getIsDirectoryRestricted

      @Nullable public Boolean getIsDirectoryRestricted()
      Whether a user is directory restricted.
      Returns:
      value for this field, or null if not present.

    • newBuilder

      public static MemberAddArgBase.Builder newBuilder(String memberEmail)
      Returns a new builder for creating an instance of this class.
      Parameters:
      memberEmail - Must have length of at most 255, match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", and 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 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