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 class
MemberAddArgBase.Builder
Builder forMemberAddArgBase
.
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.Boolean
isDirectoryRestricted
protected java.lang.String
memberEmail
protected java.lang.String
memberExternalId
protected java.lang.String
memberGivenName
protected java.lang.String
memberPersistentId
protected java.lang.String
memberSurname
protected boolean
sendWelcomeEmail
-
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 boolean
equals(java.lang.Object obj)
java.lang.Boolean
getIsDirectoryRestricted()
Whether a user is directory restricted.java.lang.String
getMemberEmail()
java.lang.String
getMemberExternalId()
External ID for member.java.lang.String
getMemberGivenName()
Member's first name.java.lang.String
getMemberPersistentId()
Persistent ID for member.java.lang.String
getMemberSurname()
Member's last name.boolean
getSendWelcomeEmail()
Whether to send a welcome email to the member.int
hashCode()
static MemberAddArgBase.Builder
newBuilder(java.lang.String memberEmail)
Returns a new builder for creating an instance of this class.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
memberEmail
@Nonnull protected final java.lang.String memberEmail
-
memberGivenName
@Nullable protected final java.lang.String memberGivenName
-
memberSurname
@Nullable protected final java.lang.String memberSurname
-
memberExternalId
@Nullable protected final java.lang.String memberExternalId
-
memberPersistentId
@Nullable protected final java.lang.String memberPersistentId
-
sendWelcomeEmail
protected final boolean sendWelcomeEmail
-
isDirectoryRestricted
@Nullable protected final java.lang.Boolean isDirectoryRestricted
-
-
Constructor Detail
-
MemberAddArgBase
public MemberAddArgBase(@Nonnull java.lang.String memberEmail, @Nullable java.lang.String memberGivenName, @Nullable java.lang.String memberSurname, @Nullable java.lang.String memberExternalId, @Nullable java.lang.String memberPersistentId, boolean sendWelcomeEmail, @Nullable 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(@Nonnull 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
@Nonnull public java.lang.String getMemberEmail()
- Returns:
- value for this field, never
null
.
-
getMemberGivenName
@Nullable public java.lang.String getMemberGivenName()
Member's first name.- Returns:
- value for this field, or
null
if not present.
-
getMemberSurname
@Nullable public java.lang.String getMemberSurname()
Member's last name.- Returns:
- value for this field, or
null
if not present.
-
getMemberExternalId
@Nullable public java.lang.String getMemberExternalId()
External ID for member.- Returns:
- value for this field, or
null
if not present.
-
getMemberPersistentId
@Nullable 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
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 java.lang.Boolean getIsDirectoryRestricted()
Whether a user is directory restricted.- Returns:
- value for this field, or
null
if 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:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in 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
-
-