Package com.dropbox.core.v2.team

Class UserResendResult

java.lang.Object

com.dropbox.core.v2.team.UserResendResult

public final class UserResendResult
extends 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 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	UserResendResult.Tag	Discriminating tag type for UserResendResult.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(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 of UserResendResult that has its tag set to UserResendResult.Tag.INVALID_USER.
boolean	isInvalidUser()	Returns true if this instance has the tag UserResendResult.Tag.INVALID_USER, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UserResendResult.Tag.OTHER, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag UserResendResult.Tag.SUCCESS, false otherwise.
static UserResendResult	success(UserResendEmailsResult value)	Returns an instance of UserResendResult that has its tag set to UserResendResult.Tag.SUCCESS.
UserResendResult.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 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 Details

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this UserResendResult.

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 has the tag UserResendResult.Tag.SUCCESS, false otherwise.

Returns:

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

success

public static UserResendResult success(UserResendEmailsResult value)

Returns an instance of UserResendResult that has its tag set to UserResendResult.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 to UserResendResult.Tag.SUCCESS.

Throws:

IllegalArgumentException - if value is null.

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 if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isInvalidUser

public boolean isInvalidUser()

Returns true if this instance has the tag UserResendResult.Tag.INVALID_USER, false otherwise.

Returns:

true if this instance is tagged as UserResendResult.Tag.INVALID_USER, false otherwise.

invalidUser

public static UserResendResult invalidUser(UserSelectorArg value)

Returns an instance of UserResendResult that has its tag set to UserResendResult.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 to UserResendResult.Tag.INVALID_USER.

Throws:

IllegalArgumentException - if value is null.

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 if isInvalidUser() is true.

Throws:

IllegalStateException - If isInvalidUser() is false.

isOther

public boolean isOther()

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

Returns:

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