Package com.dropbox.core.v2.team

Class UserAddResult

java.lang.Object

com.dropbox.core.v2.team.UserAddResult

public final class UserAddResult
extends Object

Result of trying to add secondary emails to a user. 'success' is the only value indicating that a user was successfully retrieved for adding secondary 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	UserAddResult.Tag	Discriminating tag type for UserAddResult.

Field Summary

Fields

Modifier and Type	Field	Description
static final UserAddResult	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 adding secondary emails.
UserSelectorArg	getPlaceholderUserValue()	Secondary emails cannot be added to placeholder users.
UserSecondaryEmailsResult	getSuccessValue()	Describes a user and the results for each attempt to add a secondary email.
UserSelectorArg	getUnverifiedValue()	Secondary emails can only be added to verified users.
int	hashCode()
static UserAddResult	invalidUser(UserSelectorArg value)	Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.INVALID_USER.
boolean	isInvalidUser()	Returns true if this instance has the tag UserAddResult.Tag.INVALID_USER, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UserAddResult.Tag.OTHER, false otherwise.
boolean	isPlaceholderUser()	Returns true if this instance has the tag UserAddResult.Tag.PLACEHOLDER_USER, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag UserAddResult.Tag.SUCCESS, false otherwise.
boolean	isUnverified()	Returns true if this instance has the tag UserAddResult.Tag.UNVERIFIED, false otherwise.
static UserAddResult	placeholderUser(UserSelectorArg value)	Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.PLACEHOLDER_USER.
static UserAddResult	success(UserSecondaryEmailsResult value)	Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.SUCCESS.
UserAddResult.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static UserAddResult	unverified(UserSelectorArg value)	Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.UNVERIFIED.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OTHER

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

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

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

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

Returns:

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

success

public static UserAddResult success(UserSecondaryEmailsResult value)

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

Describes a user and the results for each attempt to add a secondary email.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getSuccessValue

public UserSecondaryEmailsResult getSuccessValue()

Describes a user and the results for each attempt to add a secondary email.

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

Returns:

The UserSecondaryEmailsResult 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 UserAddResult.Tag.INVALID_USER, false otherwise.

Returns:

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

invalidUser

public static UserAddResult invalidUser(UserSelectorArg value)

Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.INVALID_USER.

Specified user is not a valid target for adding secondary emails.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserAddResult with its tag set to UserAddResult.Tag.INVALID_USER.

Throws:

IllegalArgumentException - if value is null.

getInvalidUserValue

public UserSelectorArg getInvalidUserValue()

Specified user is not a valid target for adding secondary emails.

This instance must be tagged as UserAddResult.Tag.INVALID_USER.

Returns:

The UserSelectorArg value associated with this instance if isInvalidUser() is true.

Throws:

IllegalStateException - If isInvalidUser() is false.

isUnverified

public boolean isUnverified()

Returns true if this instance has the tag UserAddResult.Tag.UNVERIFIED, false otherwise.

Returns:

true if this instance is tagged as UserAddResult.Tag.UNVERIFIED, false otherwise.

unverified

public static UserAddResult unverified(UserSelectorArg value)

Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.UNVERIFIED.

Secondary emails can only be added to verified users.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserAddResult with its tag set to UserAddResult.Tag.UNVERIFIED.

Throws:

IllegalArgumentException - if value is null.

getUnverifiedValue

public UserSelectorArg getUnverifiedValue()

Secondary emails can only be added to verified users.

This instance must be tagged as UserAddResult.Tag.UNVERIFIED.

Returns:

The UserSelectorArg value associated with this instance if isUnverified() is true.

Throws:

IllegalStateException - If isUnverified() is false.

isPlaceholderUser

public boolean isPlaceholderUser()

Returns true if this instance has the tag UserAddResult.Tag.PLACEHOLDER_USER, false otherwise.

Returns:

true if this instance is tagged as UserAddResult.Tag.PLACEHOLDER_USER, false otherwise.

placeholderUser

public static UserAddResult placeholderUser(UserSelectorArg value)

Returns an instance of UserAddResult that has its tag set to UserAddResult.Tag.PLACEHOLDER_USER.

Secondary emails cannot be added to placeholder users.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UserAddResult with its tag set to UserAddResult.Tag.PLACEHOLDER_USER.

Throws:

IllegalArgumentException - if value is null.

getPlaceholderUserValue

public UserSelectorArg getPlaceholderUserValue()

Secondary emails cannot be added to placeholder users.

This instance must be tagged as UserAddResult.Tag.PLACEHOLDER_USER.

Returns:

The UserSelectorArg value associated with this instance if isPlaceholderUser() is true.

Throws:

IllegalStateException - If isPlaceholderUser() is false.

isOther

public boolean isOther()

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

Returns:

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