Package com.dropbox.core.v2.team

Class ResendSecondaryEmailResult

java.lang.Object

com.dropbox.core.v2.team.ResendSecondaryEmailResult

public final class ResendSecondaryEmailResult
extends Object

Result of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. 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	ResendSecondaryEmailResult.Tag	Discriminating tag type for ResendSecondaryEmailResult.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getNotPendingValue()	This secondary email address is not pending for the user.
String	getRateLimitedValue()	Too many emails are being sent to this email address.
String	getSuccessValue()	A verification email was successfully sent to the secondary email address.
int	hashCode()
boolean	isNotPending()	Returns true if this instance has the tag ResendSecondaryEmailResult.Tag.NOT_PENDING, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ResendSecondaryEmailResult.Tag.OTHER, false otherwise.
boolean	isRateLimited()	Returns true if this instance has the tag ResendSecondaryEmailResult.Tag.RATE_LIMITED, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag ResendSecondaryEmailResult.Tag.SUCCESS, false otherwise.
static ResendSecondaryEmailResult	notPending(String value)	Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.Tag.NOT_PENDING.
static ResendSecondaryEmailResult	rateLimited(String value)	Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.Tag.RATE_LIMITED.
static ResendSecondaryEmailResult	success(String value)	Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.Tag.SUCCESS.
ResendSecondaryEmailResult.Tag	tag()	Returns the tag for this instance.
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 Details

OTHER

public static final ResendSecondaryEmailResult 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 ResendSecondaryEmailResult.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 ResendSecondaryEmailResult.

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

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

Returns:

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

success

public static ResendSecondaryEmailResult success(String value)

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

A verification email was successfully sent to the secondary email address.

Parameters:

value - value to assign to this instance.

Returns:

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

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.

getSuccessValue

public String getSuccessValue()

A verification email was successfully sent to the secondary email address.

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

Returns:

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

Throws:

IllegalStateException - If isSuccess() is false.

isNotPending

public boolean isNotPending()

Returns true if this instance has the tag ResendSecondaryEmailResult.Tag.NOT_PENDING, false otherwise.

Returns:

true if this instance is tagged as ResendSecondaryEmailResult.Tag.NOT_PENDING, false otherwise.

notPending

public static ResendSecondaryEmailResult notPending(String value)

Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.Tag.NOT_PENDING.

This secondary email address is not pending for the user.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ResendSecondaryEmailResult with its tag set to ResendSecondaryEmailResult.Tag.NOT_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.

getNotPendingValue

public String getNotPendingValue()

This secondary email address is not pending for the user.

This instance must be tagged as ResendSecondaryEmailResult.Tag.NOT_PENDING.

Returns:

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

Throws:

IllegalStateException - If isNotPending() is false.

isRateLimited

public boolean isRateLimited()

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

Returns:

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

rateLimited

public static ResendSecondaryEmailResult rateLimited(String value)

Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.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 ResendSecondaryEmailResult with its tag set to ResendSecondaryEmailResult.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 ResendSecondaryEmailResult.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 ResendSecondaryEmailResult.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as ResendSecondaryEmailResult.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