Class UserResendResult
- java.lang.Object
-
- com.dropbox.core.v2.team.UserResendResult
-
public final class UserResendResult extends java.lang.Object
Result of trying to resend verification emails to a user. 'success' is the only value indicating that a user was successfully retrieved for sending verification emails. The other values explain the type of error that occurred, and include the user for which the error occured.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
UserResendResult.Tag
Discriminating tag type forUserResendResult
.
-
Field Summary
Fields Modifier and Type Field Description static UserResendResult
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)
UserSelectorArg
getInvalidUserValue()
Specified user is not a valid target for resending verification emails.UserResendEmailsResult
getSuccessValue()
Describes a user and the results for each attempt to resend verification emails.int
hashCode()
static UserResendResult
invalidUser(UserSelectorArg value)
Returns an instance ofUserResendResult
that has its tag set toUserResendResult.Tag.INVALID_USER
.boolean
isInvalidUser()
boolean
isOther()
boolean
isSuccess()
static UserResendResult
success(UserResendEmailsResult value)
Returns an instance ofUserResendResult
that has its tag set toUserResendResult.Tag.SUCCESS
.UserResendResult.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 UserResendResult 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 UserResendResult.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 thisUserResendResult
.If a tag returned by the server is unrecognized by this SDK, the
UserResendResult.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isSuccess
public boolean isSuccess()
- Returns:
true
if this instance is tagged asUserResendResult.Tag.SUCCESS
,false
otherwise.
-
success
public static UserResendResult success(UserResendEmailsResult value)
Returns an instance ofUserResendResult
that has its tag set toUserResendResult.Tag.SUCCESS
.Describes a user and the results for each attempt to resend verification emails.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
UserResendResult
with its tag set toUserResendResult.Tag.SUCCESS
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getSuccessValue
public UserResendEmailsResult getSuccessValue()
Describes a user and the results for each attempt to resend verification emails.This instance must be tagged as
UserResendResult.Tag.SUCCESS
.- Returns:
- The
UserResendEmailsResult
value associated with this instance ifisSuccess()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisSuccess()
isfalse
.
-
isInvalidUser
public boolean isInvalidUser()
- Returns:
true
if this instance is tagged asUserResendResult.Tag.INVALID_USER
,false
otherwise.
-
invalidUser
public static UserResendResult invalidUser(UserSelectorArg value)
Returns an instance ofUserResendResult
that has its tag set toUserResendResult.Tag.INVALID_USER
.Specified user is not a valid target for resending verification emails.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
UserResendResult
with its tag set toUserResendResult.Tag.INVALID_USER
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getInvalidUserValue
public UserSelectorArg getInvalidUserValue()
Specified user is not a valid target for resending verification emails.This instance must be tagged as
UserResendResult.Tag.INVALID_USER
.- Returns:
- The
UserSelectorArg
value associated with this instance ifisInvalidUser()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisInvalidUser()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asUserResendResult.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
-
-