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 java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMemberAddArgBase.BuilderBuilder forMemberAddArgBase.
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.BooleanisDirectoryRestrictedprotected java.lang.StringmemberEmailprotected java.lang.StringmemberExternalIdprotected java.lang.StringmemberGivenNameprotected java.lang.StringmemberPersistentIdprotected java.lang.StringmemberSurnameprotected booleansendWelcomeEmail
-
Constructor Summary
Constructors Constructor Description MemberAddArgBase(java.lang.String memberEmail)NoneMemberAddArgBase(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)UsenewBuilder(java.lang.String)to create instances of this class without specifying values for all optional fields.
-
Method Summary
All 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.booleangetSendWelcomeEmail()Whether to send a welcome email to the member.inthashCode()static MemberAddArgBase.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
-
memberEmail
protected final java.lang.String memberEmail
-
memberGivenName
protected final java.lang.String memberGivenName
-
memberSurname
protected final java.lang.String memberSurname
-
memberExternalId
protected final java.lang.String memberExternalId
-
memberPersistentId
protected final java.lang.String memberPersistentId
-
sendWelcomeEmail
protected final boolean sendWelcomeEmail
-
isDirectoryRestricted
protected final java.lang.Boolean isDirectoryRestricted
-
-
Constructor Detail
-
MemberAddArgBase
public MemberAddArgBase(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)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 benull.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.- Throws:
java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
-
MemberAddArgBase
public MemberAddArgBase(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 benull.- Throws:
java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
-
-
Method Detail
-
getMemberEmail
public java.lang.String getMemberEmail()
- Returns:
- value for this field, never
null.
-
getMemberGivenName
public java.lang.String getMemberGivenName()
Member's first name.- Returns:
- value for this field, or
nullif not present.
-
getMemberSurname
public java.lang.String getMemberSurname()
Member's last name.- Returns:
- value for this field, or
nullif not present.
-
getMemberExternalId
public java.lang.String getMemberExternalId()
External ID for member.- Returns:
- value for this field, or
nullif not present.
-
getMemberPersistentId
public java.lang.String getMemberPersistentId()
Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.- Returns:
- value for this field, or
nullif 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
nullif not present. Defaults to true.
-
getIsDirectoryRestricted
public java.lang.Boolean getIsDirectoryRestricted()
Whether a user is directory restricted.- Returns:
- value for this field, or
nullif not present.
-
newBuilder
public static MemberAddArgBase.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 benull.- Returns:
- builder for this class.
- Throws:
java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
toStringMultiline
public java.lang.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
-
-