Class ResendSecondaryEmailResult
- java.lang.Object
-
- com.dropbox.core.v2.team.ResendSecondaryEmailResult
-
public final class ResendSecondaryEmailResult extends java.lang.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 returntrue
. You can usetag()
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 class
ResendSecondaryEmailResult.Tag
Discriminating tag type forResendSecondaryEmailResult
.
-
Field Summary
Fields Modifier and Type Field Description static ResendSecondaryEmailResult
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getNotPendingValue()
This secondary email address is not pending for the user.java.lang.String
getRateLimitedValue()
Too many emails are being sent to this email address.java.lang.String
getSuccessValue()
A verification email was successfully sent to the secondary email address.int
hashCode()
boolean
isNotPending()
Returnstrue
if this instance has the tagResendSecondaryEmailResult.Tag.NOT_PENDING
,false
otherwise.boolean
isOther()
boolean
isRateLimited()
Returnstrue
if this instance has the tagResendSecondaryEmailResult.Tag.RATE_LIMITED
,false
otherwise.boolean
isSuccess()
static ResendSecondaryEmailResult
notPending(java.lang.String value)
Returns an instance ofResendSecondaryEmailResult
that has its tag set toResendSecondaryEmailResult.Tag.NOT_PENDING
.static ResendSecondaryEmailResult
rateLimited(java.lang.String value)
Returns an instance ofResendSecondaryEmailResult
that has its tag set toResendSecondaryEmailResult.Tag.RATE_LIMITED
.static ResendSecondaryEmailResult
success(java.lang.String value)
Returns an instance ofResendSecondaryEmailResult
that has its tag set toResendSecondaryEmailResult.Tag.SUCCESS
.ResendSecondaryEmailResult.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisResendSecondaryEmailResult
.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 is tagged asResendSecondaryEmailResult.Tag.SUCCESS
,false
otherwise.
-
success
public static ResendSecondaryEmailResult success(java.lang.String value)
Returns an instance ofResendSecondaryEmailResult
that has its tag set toResendSecondaryEmailResult.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 toResendSecondaryEmailResult.Tag.SUCCESS
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
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 isnull
.
-
getSuccessValue
public java.lang.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 ifisSuccess()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisSuccess()
isfalse
.
-
isNotPending
public boolean isNotPending()
Returnstrue
if this instance has the tagResendSecondaryEmailResult.Tag.NOT_PENDING
,false
otherwise.- Returns:
true
if this instance is tagged asResendSecondaryEmailResult.Tag.NOT_PENDING
,false
otherwise.
-
notPending
public static ResendSecondaryEmailResult notPending(java.lang.String value)
Returns an instance ofResendSecondaryEmailResult
that has its tag set toResendSecondaryEmailResult.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 toResendSecondaryEmailResult.Tag.NOT_PENDING
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
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 isnull
.
-
getNotPendingValue
public java.lang.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 ifisNotPending()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisNotPending()
isfalse
.
-
isRateLimited
public boolean isRateLimited()
Returnstrue
if this instance has the tagResendSecondaryEmailResult.Tag.RATE_LIMITED
,false
otherwise.- Returns:
true
if this instance is tagged asResendSecondaryEmailResult.Tag.RATE_LIMITED
,false
otherwise.
-
rateLimited
public static ResendSecondaryEmailResult rateLimited(java.lang.String value)
Returns an instance ofResendSecondaryEmailResult
that has its tag set toResendSecondaryEmailResult.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 toResendSecondaryEmailResult.Tag.RATE_LIMITED
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
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 isnull
.
-
getRateLimitedValue
public java.lang.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 ifisRateLimited()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisRateLimited()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asResendSecondaryEmailResult.Tag.OTHER
,false
otherwise.
-
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
-
-