Class UserAddResult
- java.lang.Object
-
- com.dropbox.core.v2.team.UserAddResult
-
public final class UserAddResult extends java.lang.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 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
UserAddResult.Tag
Discriminating tag type forUserAddResult
.
-
Field Summary
Fields Modifier and Type Field Description static UserAddResult
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 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 ofUserAddResult
that has its tag set toUserAddResult.Tag.INVALID_USER
.boolean
isInvalidUser()
boolean
isOther()
boolean
isPlaceholderUser()
boolean
isSuccess()
boolean
isUnverified()
static UserAddResult
placeholderUser(UserSelectorArg value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.Tag.PLACEHOLDER_USER
.static UserAddResult
success(UserSecondaryEmailsResult value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.Tag.SUCCESS
.UserAddResult.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.static UserAddResult
unverified(UserSelectorArg value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.Tag.UNVERIFIED
.
-
-
-
Field Detail
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisUserAddResult
.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 is tagged asUserAddResult.Tag.SUCCESS
,false
otherwise.
-
success
public static UserAddResult success(UserSecondaryEmailsResult value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.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 toUserAddResult.Tag.SUCCESS
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisSuccess()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisSuccess()
isfalse
.
-
isInvalidUser
public boolean isInvalidUser()
- Returns:
true
if this instance is tagged asUserAddResult.Tag.INVALID_USER
,false
otherwise.
-
invalidUser
public static UserAddResult invalidUser(UserSelectorArg value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.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 toUserAddResult.Tag.INVALID_USER
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisInvalidUser()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisInvalidUser()
isfalse
.
-
isUnverified
public boolean isUnverified()
- Returns:
true
if this instance is tagged asUserAddResult.Tag.UNVERIFIED
,false
otherwise.
-
unverified
public static UserAddResult unverified(UserSelectorArg value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.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 toUserAddResult.Tag.UNVERIFIED
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisUnverified()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisUnverified()
isfalse
.
-
isPlaceholderUser
public boolean isPlaceholderUser()
- Returns:
true
if this instance is tagged asUserAddResult.Tag.PLACEHOLDER_USER
,false
otherwise.
-
placeholderUser
public static UserAddResult placeholderUser(UserSelectorArg value)
Returns an instance ofUserAddResult
that has its tag set toUserAddResult.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 toUserAddResult.Tag.PLACEHOLDER_USER
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisPlaceholderUser()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPlaceholderUser()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asUserAddResult.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
-
-