Package com.dropbox.core.v2.team
Class MemberAddArg
- java.lang.Object
- 
- com.dropbox.core.v2.team.MemberAddArgBase
- 
- com.dropbox.core.v2.team.MemberAddArg
 
 
- 
 public class MemberAddArg extends MemberAddArgBase 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classMemberAddArg.BuilderBuilder forMemberAddArg.
 - 
Field SummaryFields Modifier and Type Field Description protected AdminTierrole- 
Fields inherited from class com.dropbox.core.v2.team.MemberAddArgBaseisDirectoryRestricted, memberEmail, memberExternalId, memberGivenName, memberPersistentId, memberSurname, sendWelcomeEmail
 
- 
 - 
Constructor SummaryConstructors Constructor Description MemberAddArg(java.lang.String memberEmail)NoneMemberAddArg(java.lang.String memberEmail, java.lang.String memberGivenName, java.lang.String memberSurname, java.lang.String memberExternalId, java.lang.String memberPersistentId, boolean sendWelcomeEmail, java.lang.Boolean isDirectoryRestricted, AdminTier role)UsenewBuilder(java.lang.String)to create instances of this class without specifying values for all optional fields.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)java.lang.BooleangetIsDirectoryRestricted()Whether a user is directory restricted.java.lang.StringgetMemberEmail()java.lang.StringgetMemberExternalId()External ID for member.java.lang.StringgetMemberGivenName()Member's first name.java.lang.StringgetMemberPersistentId()Persistent ID for member.java.lang.StringgetMemberSurname()Member's last name.AdminTiergetRole()booleangetSendWelcomeEmail()Whether to send a welcome email to the member.inthashCode()static MemberAddArg.BuildernewBuilder(java.lang.String memberEmail)Returns a new builder for creating an instance of this class.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
 
- 
- 
- 
Field Detail- 
roleprotected final AdminTier role 
 
- 
 - 
Constructor Detail- 
MemberAddArgpublic MemberAddArg(java.lang.String memberEmail, java.lang.String memberGivenName, java.lang.String memberSurname, java.lang.String memberExternalId, java.lang.String memberPersistentId, boolean sendWelcomeEmail, java.lang.Boolean isDirectoryRestricted, AdminTier role)UsenewBuilder(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 100 and match pattern "- [^/:?*<>\"|]*".
- memberSurname- Member's last name. Must have length of at most 100 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.
- role- Must not be- null.
- Throws:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
MemberAddArgpublic MemberAddArg(java.lang.String memberEmail) NoneThe 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:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 
- 
 - 
Method Detail- 
getMemberEmailpublic java.lang.String getMemberEmail() - Overrides:
- getMemberEmailin class- MemberAddArgBase
- Returns:
- value for this field, never null.
 
 - 
getMemberGivenNamepublic java.lang.String getMemberGivenName() Member's first name.- Overrides:
- getMemberGivenNamein class- MemberAddArgBase
- Returns:
- value for this field, or nullif not present.
 
 - 
getMemberSurnamepublic java.lang.String getMemberSurname() Member's last name.- Overrides:
- getMemberSurnamein class- MemberAddArgBase
- Returns:
- value for this field, or nullif not present.
 
 - 
getMemberExternalIdpublic java.lang.String getMemberExternalId() External ID for member.- Overrides:
- getMemberExternalIdin class- MemberAddArgBase
- Returns:
- value for this field, or nullif not present.
 
 - 
getMemberPersistentIdpublic java.lang.String getMemberPersistentId() Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.- Overrides:
- getMemberPersistentIdin class- MemberAddArgBase
- Returns:
- value for this field, or nullif not present.
 
 - 
getSendWelcomeEmailpublic 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.- Overrides:
- getSendWelcomeEmailin class- MemberAddArgBase
- Returns:
- value for this field, or nullif not present. Defaults to true.
 
 - 
getIsDirectoryRestrictedpublic java.lang.Boolean getIsDirectoryRestricted() Whether a user is directory restricted.- Overrides:
- getIsDirectoryRestrictedin class- MemberAddArgBase
- Returns:
- value for this field, or nullif not present.
 
 - 
getRolepublic AdminTier getRole() - Returns:
- value for this field, or nullif not present. Defaults to AdminTier.MEMBER_ONLY.
 
 - 
newBuilderpublic static MemberAddArg.Builder newBuilder(java.lang.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:
- java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- MemberAddArgBase
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- MemberAddArgBase
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- MemberAddArgBase
 
 - 
toStringMultilinepublic java.lang.String toStringMultiline() Returns a String representation of this object formatted for easier readability.The returned String may contain newlines. - Overrides:
- toStringMultilinein class- MemberAddArgBase
- Returns:
- Formatted, multiline String representation of this object
 
 
- 
 
-