public final class ResendSecondaryEmailResult
extends java.lang.Object
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.
Modifier and Type | Class and Description |
---|---|
static class |
ResendSecondaryEmailResult.Tag
Discriminating tag type for
ResendSecondaryEmailResult . |
Modifier and Type | Field and Description |
---|---|
static ResendSecondaryEmailResult |
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
|
Modifier and Type | Method and 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()
Returns
true if this instance has the tag ResendSecondaryEmailResult.Tag.NOT_PENDING , false otherwise. |
boolean |
isOther()
|
boolean |
isRateLimited()
Returns
true if this instance has the tag ResendSecondaryEmailResult.Tag.RATE_LIMITED , false otherwise. |
boolean |
isSuccess()
|
static ResendSecondaryEmailResult |
notPending(java.lang.String value)
Returns an instance of
ResendSecondaryEmailResult that has its
tag set to ResendSecondaryEmailResult.Tag.NOT_PENDING . |
static ResendSecondaryEmailResult |
rateLimited(java.lang.String value)
Returns an instance of
ResendSecondaryEmailResult that has its
tag set to ResendSecondaryEmailResult.Tag.RATE_LIMITED . |
static ResendSecondaryEmailResult |
success(java.lang.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.
|
java.lang.String |
toString() |
java.lang.String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
public static final ResendSecondaryEmailResult OTHER
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.
public ResendSecondaryEmailResult.Tag tag()
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.
public boolean isSuccess()
true
if this instance is tagged as ResendSecondaryEmailResult.Tag.SUCCESS
,
false
otherwise.public static ResendSecondaryEmailResult success(java.lang.String value)
ResendSecondaryEmailResult
that has its
tag set to ResendSecondaryEmailResult.Tag.SUCCESS
.
A verification email was successfully sent to the secondary email address.
value
- value to assign to this instance.ResendSecondaryEmailResult
with its tag set
to ResendSecondaryEmailResult.Tag.SUCCESS
.java.lang.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
.public java.lang.String getSuccessValue()
This instance must be tagged as ResendSecondaryEmailResult.Tag.SUCCESS
.
String
value associated with this instance if isSuccess()
is true
.java.lang.IllegalStateException
- If isSuccess()
is false
.public boolean isNotPending()
true
if this instance has the tag ResendSecondaryEmailResult.Tag.NOT_PENDING
, false
otherwise.true
if this instance is tagged as ResendSecondaryEmailResult.Tag.NOT_PENDING
, false
otherwise.public static ResendSecondaryEmailResult notPending(java.lang.String value)
ResendSecondaryEmailResult
that has its
tag set to ResendSecondaryEmailResult.Tag.NOT_PENDING
.
This secondary email address is not pending for the user.
value
- value to assign to this instance.ResendSecondaryEmailResult
with its tag set
to ResendSecondaryEmailResult.Tag.NOT_PENDING
.java.lang.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
.public java.lang.String getNotPendingValue()
This instance must be tagged as ResendSecondaryEmailResult.Tag.NOT_PENDING
.
String
value associated with this instance if isNotPending()
is true
.java.lang.IllegalStateException
- If isNotPending()
is false
.public boolean isRateLimited()
true
if this instance has the tag ResendSecondaryEmailResult.Tag.RATE_LIMITED
, false
otherwise.true
if this instance is tagged as ResendSecondaryEmailResult.Tag.RATE_LIMITED
, false
otherwise.public static ResendSecondaryEmailResult rateLimited(java.lang.String value)
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.
value
- value to assign to this instance.ResendSecondaryEmailResult
with its tag set
to ResendSecondaryEmailResult.Tag.RATE_LIMITED
.java.lang.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
.public java.lang.String getRateLimitedValue()
This instance must be tagged as ResendSecondaryEmailResult.Tag.RATE_LIMITED
.
String
value associated with this instance if isRateLimited()
is true
.java.lang.IllegalStateException
- If isRateLimited()
is false
.public boolean isOther()
true
if this instance is tagged as ResendSecondaryEmailResult.Tag.OTHER
,
false
otherwise.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringMultiline()
The returned String may contain newlines.