Package com.dropbox.core.v2.team

Class AddSecondaryEmailResult

java.lang.Object

com.dropbox.core.v2.team.AddSecondaryEmailResult

public final class AddSecondaryEmailResult
extends Object

Result of trying to add a secondary email to a user. 'success' is the only value indicating that a secondary email was successfully added to a user. The other values explain the type of error that occurred, and include the email for which the error occurred.

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AddSecondaryEmailResult.Tag	Discriminating tag type for AddSecondaryEmailResult.

Field Summary

Fields

Modifier and Type	Field	Description
static final AddSecondaryEmailResult	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static AddSecondaryEmailResult	alreadyOwnedByUser(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER.
static AddSecondaryEmailResult	alreadyPending(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.ALREADY_PENDING.
boolean	equals(Object obj)
String	getAlreadyOwnedByUserValue()	Secondary email is already a verified email for the user.
String	getAlreadyPendingValue()	Secondary email is already a pending email for the user.
String	getRateLimitedValue()	Too many emails are being sent to this email address.
String	getReachedLimitValue()	User already has the maximum number of secondary emails allowed.
SecondaryEmail	getSuccessValue()	Describes a secondary email that was successfully added to a user.
String	getTooManyUpdatesValue()	An error occurred due to conflicting updates.
String	getTransientErrorValue()	Field is deprecated.
String	getUnavailableValue()	Secondary email is not available to be claimed by the user.
String	getUnknownErrorValue()	An unknown error occurred.
int	hashCode()
boolean	isAlreadyOwnedByUser()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER, false otherwise.
boolean	isAlreadyPending()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.ALREADY_PENDING, false otherwise.
boolean	isOther()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.OTHER, false otherwise.
boolean	isRateLimited()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.RATE_LIMITED, false otherwise.
boolean	isReachedLimit()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.REACHED_LIMIT, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.SUCCESS, false otherwise.
boolean	isTooManyUpdates()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES, false otherwise.
boolean	isTransientError()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.TRANSIENT_ERROR, false otherwise.
boolean	isUnavailable()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.UNAVAILABLE, false otherwise.
boolean	isUnknownError()	Returns true if this instance has the tag AddSecondaryEmailResult.Tag.UNKNOWN_ERROR, false otherwise.
static AddSecondaryEmailResult	rateLimited(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.RATE_LIMITED.
static AddSecondaryEmailResult	reachedLimit(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.REACHED_LIMIT.
static AddSecondaryEmailResult	success(SecondaryEmail value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.SUCCESS.
AddSecondaryEmailResult.Tag	tag()	Returns the tag for this instance.
static AddSecondaryEmailResult	tooManyUpdates(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static AddSecondaryEmailResult	transientError(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.TRANSIENT_ERROR.
static AddSecondaryEmailResult	unavailable(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.UNAVAILABLE.
static AddSecondaryEmailResult	unknownError(String value)	Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.UNKNOWN_ERROR.

Methods inherited from class java.lang.Object

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

Field Details

OTHER

public static final AddSecondaryEmailResult OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

public AddSecondaryEmailResult.Tag tag()

Returns the tag for this instance.

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this AddSecondaryEmailResult.

If a tag returned by the server is unrecognized by this SDK, the AddSecondaryEmailResult.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.SUCCESS, false otherwise.

success

public static AddSecondaryEmailResult success(SecondaryEmail value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.SUCCESS.

Describes a secondary email that was successfully added to a user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.SUCCESS.

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public SecondaryEmail getSuccessValue()

Describes a secondary email that was successfully added to a user.

This instance must be tagged as AddSecondaryEmailResult.Tag.SUCCESS.

Returns:

The SecondaryEmail value associated with this instance if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isUnavailable

public boolean isUnavailable()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.UNAVAILABLE, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.UNAVAILABLE, false otherwise.

unavailable

public static AddSecondaryEmailResult unavailable(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.UNAVAILABLE.

Secondary email is not available to be claimed by the user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.UNAVAILABLE.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getUnavailableValue

public String getUnavailableValue()

Secondary email is not available to be claimed by the user.

This instance must be tagged as AddSecondaryEmailResult.Tag.UNAVAILABLE.

Returns:

The String value associated with this instance if isUnavailable() is true.

Throws:

IllegalStateException - If isUnavailable() is false.

isAlreadyPending

public boolean isAlreadyPending()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.ALREADY_PENDING, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.ALREADY_PENDING, false otherwise.

alreadyPending

public static AddSecondaryEmailResult alreadyPending(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.ALREADY_PENDING.

Secondary email is already a pending email for the user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.ALREADY_PENDING.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getAlreadyPendingValue

public String getAlreadyPendingValue()

Secondary email is already a pending email for the user.

This instance must be tagged as AddSecondaryEmailResult.Tag.ALREADY_PENDING.

Returns:

The String value associated with this instance if isAlreadyPending() is true.

Throws:

IllegalStateException - If isAlreadyPending() is false.

isAlreadyOwnedByUser

public boolean isAlreadyOwnedByUser()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER, false otherwise.

alreadyOwnedByUser

public static AddSecondaryEmailResult alreadyOwnedByUser(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER.

Secondary email is already a verified email for the user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getAlreadyOwnedByUserValue

public String getAlreadyOwnedByUserValue()

Secondary email is already a verified email for the user.

This instance must be tagged as AddSecondaryEmailResult.Tag.ALREADY_OWNED_BY_USER.

Returns:

The String value associated with this instance if isAlreadyOwnedByUser() is true.

Throws:

IllegalStateException - If isAlreadyOwnedByUser() is false.

isReachedLimit

public boolean isReachedLimit()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.REACHED_LIMIT, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.REACHED_LIMIT, false otherwise.

reachedLimit

public static AddSecondaryEmailResult reachedLimit(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.REACHED_LIMIT.

User already has the maximum number of secondary emails allowed.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.REACHED_LIMIT.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getReachedLimitValue

public String getReachedLimitValue()

User already has the maximum number of secondary emails allowed.

This instance must be tagged as AddSecondaryEmailResult.Tag.REACHED_LIMIT.

Returns:

The String value associated with this instance if isReachedLimit() is true.

Throws:

IllegalStateException - If isReachedLimit() is false.

isTransientError

public boolean isTransientError()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.TRANSIENT_ERROR, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.TRANSIENT_ERROR, false otherwise.

transientError

public static AddSecondaryEmailResult transientError(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.TRANSIENT_ERROR.

Field is deprecated. A transient error occurred. Please try again later.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.TRANSIENT_ERROR.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getTransientErrorValue

public String getTransientErrorValue()

Field is deprecated. A transient error occurred. Please try again later.

This instance must be tagged as AddSecondaryEmailResult.Tag.TRANSIENT_ERROR.

Returns:

The String value associated with this instance if isTransientError() is true.

Throws:

IllegalStateException - If isTransientError() is false.

isTooManyUpdates

public boolean isTooManyUpdates()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES, false otherwise.

tooManyUpdates

public static AddSecondaryEmailResult tooManyUpdates(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES.

An error occurred due to conflicting updates. Please try again later.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getTooManyUpdatesValue

public String getTooManyUpdatesValue()

An error occurred due to conflicting updates. Please try again later.

This instance must be tagged as AddSecondaryEmailResult.Tag.TOO_MANY_UPDATES.

Returns:

The String value associated with this instance if isTooManyUpdates() is true.

Throws:

IllegalStateException - If isTooManyUpdates() is false.

isUnknownError

public boolean isUnknownError()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.UNKNOWN_ERROR, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.UNKNOWN_ERROR, false otherwise.

unknownError

public static AddSecondaryEmailResult unknownError(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.UNKNOWN_ERROR.

An unknown error occurred.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.UNKNOWN_ERROR.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getUnknownErrorValue

public String getUnknownErrorValue()

An unknown error occurred.

This instance must be tagged as AddSecondaryEmailResult.Tag.UNKNOWN_ERROR.

Returns:

The String value associated with this instance if isUnknownError() is true.

Throws:

IllegalStateException - If isUnknownError() is false.

isRateLimited

public boolean isRateLimited()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.RATE_LIMITED, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.RATE_LIMITED, false otherwise.

rateLimited

public static AddSecondaryEmailResult rateLimited(String value)

Returns an instance of AddSecondaryEmailResult that has its tag set to AddSecondaryEmailResult.Tag.RATE_LIMITED.

Too many emails are being sent to this email address. Please try again later.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddSecondaryEmailResult with its tag set to AddSecondaryEmailResult.Tag.RATE_LIMITED.

Throws:

IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.

getRateLimitedValue

public String getRateLimitedValue()

Too many emails are being sent to this email address. Please try again later.

This instance must be tagged as AddSecondaryEmailResult.Tag.RATE_LIMITED.

Returns:

The String value associated with this instance if isRateLimited() is true.

Throws:

IllegalStateException - If isRateLimited() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag AddSecondaryEmailResult.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as AddSecondaryEmailResult.Tag.OTHER, false otherwise.

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