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 Summary
Nested Classes Modifier and Type Class Description static classMemberAddArg.BuilderBuilder forMemberAddArg.
-
Field Summary
Fields Modifier and Type Field Description protected AdminTierrole-
Fields inherited from class com.dropbox.core.v2.team.MemberAddArgBase
isDirectoryRestricted, memberEmail, memberExternalId, memberGivenName, memberPersistentId, memberSurname, sendWelcomeEmail
-
-
Constructor Summary
Constructors 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 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.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
-
role
protected final AdminTier role
-
-
Constructor Detail
-
MemberAddArg
public 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 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.role- Must not benull.- Throws:
java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
-
MemberAddArg
public 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 benull.- Throws:
java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
-
-
Method Detail
-
getMemberEmail
public java.lang.String getMemberEmail()
- Overrides:
getMemberEmailin classMemberAddArgBase- Returns:
- value for this field, never
null.
-
getMemberGivenName
public java.lang.String getMemberGivenName()
Member's first name.- Overrides:
getMemberGivenNamein classMemberAddArgBase- Returns:
- value for this field, or
nullif not present.
-
getMemberSurname
public java.lang.String getMemberSurname()
Member's last name.- Overrides:
getMemberSurnamein classMemberAddArgBase- Returns:
- value for this field, or
nullif not present.
-
getMemberExternalId
public java.lang.String getMemberExternalId()
External ID for member.- Overrides:
getMemberExternalIdin classMemberAddArgBase- 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.- Overrides:
getMemberPersistentIdin classMemberAddArgBase- 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.- Overrides:
getSendWelcomeEmailin classMemberAddArgBase- Returns:
- value for this field, or
nullif not present. Defaults to true.
-
getIsDirectoryRestricted
public java.lang.Boolean getIsDirectoryRestricted()
Whether a user is directory restricted.- Overrides:
getIsDirectoryRestrictedin classMemberAddArgBase- Returns:
- value for this field, or
nullif not present.
-
getRole
public AdminTier getRole()
- Returns:
- value for this field, or
nullif not present. Defaults to AdminTier.MEMBER_ONLY.
-
newBuilder
public 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 benull.- Returns:
- builder for this class.
- Throws:
java.lang.IllegalArgumentException- If any argument does not meet its preconditions.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classMemberAddArgBase
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classMemberAddArgBase
-
toString
public java.lang.String toString()
- Overrides:
toStringin classMemberAddArgBase
-
toStringMultiline
public java.lang.String toStringMultiline()
Returns a String representation of this object formatted for easier readability.The returned String may contain newlines.
- Overrides:
toStringMultilinein classMemberAddArgBase- Returns:
- Formatted, multiline String representation of this object
-
-