com.dropbox.core.v2.team

Class MemberAddArg

java.lang.Object

com.dropbox.core.v2.team.MemberAddArg

public class MemberAddArg
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MemberAddArg.Builder Builder for MemberAddArg.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	memberEmail
protected String	memberExternalId
protected String	memberGivenName
protected String	memberSurname
protected AdminTier	role
protected boolean	sendWelcomeEmail

Constructor Summary

Constructors

Constructor and Description
MemberAddArg(String memberEmail, String memberGivenName, String memberSurname) None
MemberAddArg(String memberEmail, String memberGivenName, String memberSurname, String memberExternalId, boolean sendWelcomeEmail, AdminTier role) Use newBuilder to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMemberEmail()
String	getMemberExternalId() External ID for member.
String	getMemberGivenName() Member's first name.
String	getMemberSurname() Member's last name.
AdminTier	getRole()
boolean	getSendWelcomeEmail() Whether to send a welcome email to the member.
int	hashCode()
static MemberAddArg.Builder	newBuilder(String memberEmail, String memberGivenName, String memberSurname) Returns a new builder for creating an instance of this class.
String	toString()
String	toStringMultiline() Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

memberEmail

protected final String memberEmail

memberGivenName

protected final String memberGivenName

memberSurname

protected final String memberSurname

memberExternalId

protected final String memberExternalId

sendWelcomeEmail

protected final boolean sendWelcomeEmail

role

protected final AdminTier role

Constructor Detail

MemberAddArg

public MemberAddArg(String memberEmail,
                    String memberGivenName,
                    String memberSurname,
                    String memberExternalId,
                    boolean sendWelcomeEmail,
                    AdminTier role)

Use newBuilder 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 least 1, have length of at most 100, match pattern "[^/:?*<>\"|]*", and not be null.

memberSurname - Member's last name. Must have length of at least 1, have length of at most 100, match pattern "[^/:?*<>\"|]*", and not be null.

memberExternalId - External ID for member. Must have length of at most 64.

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.

role - Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

MemberAddArg

public MemberAddArg(String memberEmail,
                    String memberGivenName,
                    String memberSurname)

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.

memberGivenName - Member's first name. Must have length of at least 1, have length of at most 100, match pattern "[^/:?*<>\"|]*", and not be null.

memberSurname - Member's last name. Must have length of at least 1, have length of at most 100, match pattern "[^/:?*<>\"|]*", and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getMemberEmail

public String getMemberEmail()

Returns:

value for this field, never null.

getMemberGivenName

public String getMemberGivenName()

Member's first name.

Returns:

value for this field, never null.

getMemberSurname

public String getMemberSurname()

Member's last name.

Returns:

value for this field, never null.

getMemberExternalId

public String getMemberExternalId()

External ID for member.

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.

getRole

public AdminTier getRole()

Returns:

value for this field, or null if not present. Defaults to AdminTier.MEMBER_ONLY.

newBuilder

public static MemberAddArg.Builder newBuilder(String memberEmail,
                                              String memberGivenName,
                                              String memberSurname)

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.

memberGivenName - Member's first name. Must have length of at least 1, have length of at most 100, match pattern "[^/:?*<>\"|]*", and not be null.

memberSurname - Member's last name. Must have length of at least 1, have length of at most 100, match pattern "[^/:?*<>\"|]*", 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