Class UserAddResult
- java.lang.Object
- 
- com.dropbox.core.v2.team.UserAddResult
 
- 
 public final class UserAddResult extends java.lang.ObjectResult 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 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 OTHERvalue will be used.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classUserAddResult.TagDiscriminating tag type forUserAddResult.
 - 
Field SummaryFields Modifier and Type Field Description static UserAddResultOTHERCatch-all used for unknown tag values returned by the Dropbox servers.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)UserSelectorArggetInvalidUserValue()Specified user is not a valid target for adding secondary emails.UserSelectorArggetPlaceholderUserValue()Secondary emails cannot be added to placeholder users.UserSecondaryEmailsResultgetSuccessValue()Describes a user and the results for each attempt to add a secondary email.UserSelectorArggetUnverifiedValue()Secondary emails can only be added to verified users.inthashCode()static UserAddResultinvalidUser(UserSelectorArg value)Returns an instance ofUserAddResultthat has its tag set toUserAddResult.Tag.INVALID_USER.booleanisInvalidUser()booleanisOther()booleanisPlaceholderUser()booleanisSuccess()booleanisUnverified()static UserAddResultplaceholderUser(UserSelectorArg value)Returns an instance ofUserAddResultthat has its tag set toUserAddResult.Tag.PLACEHOLDER_USER.static UserAddResultsuccess(UserSecondaryEmailsResult value)Returns an instance ofUserAddResultthat has its tag set toUserAddResult.Tag.SUCCESS.UserAddResult.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.static UserAddResultunverified(UserSelectorArg value)Returns an instance ofUserAddResultthat has its tag set toUserAddResult.Tag.UNVERIFIED.
 
- 
- 
- 
Field Detail- 
OTHERpublic 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- 
tagpublic 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 aswitchstatement to properly handle the different values for thisUserAddResult.If a tag returned by the server is unrecognized by this SDK, the UserAddResult.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
 
 - 
isSuccesspublic boolean isSuccess() - Returns:
- trueif this instance is tagged as- UserAddResult.Tag.SUCCESS,- falseotherwise.
 
 - 
successpublic static UserAddResult success(UserSecondaryEmailsResult value) Returns an instance ofUserAddResultthat 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 UserAddResultwith its tag set toUserAddResult.Tag.SUCCESS.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getSuccessValuepublic 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 UserSecondaryEmailsResultvalue associated with this instance ifisSuccess()istrue.
- Throws:
- java.lang.IllegalStateException- If- isSuccess()is- false.
 
 - 
isInvalidUserpublic boolean isInvalidUser() - Returns:
- trueif this instance is tagged as- UserAddResult.Tag.INVALID_USER,- falseotherwise.
 
 - 
invalidUserpublic static UserAddResult invalidUser(UserSelectorArg value) Returns an instance ofUserAddResultthat 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 UserAddResultwith its tag set toUserAddResult.Tag.INVALID_USER.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getInvalidUserValuepublic 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 UserSelectorArgvalue associated with this instance ifisInvalidUser()istrue.
- Throws:
- java.lang.IllegalStateException- If- isInvalidUser()is- false.
 
 - 
isUnverifiedpublic boolean isUnverified() - Returns:
- trueif this instance is tagged as- UserAddResult.Tag.UNVERIFIED,- falseotherwise.
 
 - 
unverifiedpublic static UserAddResult unverified(UserSelectorArg value) Returns an instance ofUserAddResultthat 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 UserAddResultwith its tag set toUserAddResult.Tag.UNVERIFIED.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getUnverifiedValuepublic UserSelectorArg getUnverifiedValue() Secondary emails can only be added to verified users.This instance must be tagged as UserAddResult.Tag.UNVERIFIED.- Returns:
- The UserSelectorArgvalue associated with this instance ifisUnverified()istrue.
- Throws:
- java.lang.IllegalStateException- If- isUnverified()is- false.
 
 - 
isPlaceholderUserpublic boolean isPlaceholderUser() - Returns:
- trueif this instance is tagged as- UserAddResult.Tag.PLACEHOLDER_USER,- falseotherwise.
 
 - 
placeholderUserpublic static UserAddResult placeholderUser(UserSelectorArg value) Returns an instance ofUserAddResultthat 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 UserAddResultwith its tag set toUserAddResult.Tag.PLACEHOLDER_USER.
- Throws:
- java.lang.IllegalArgumentException- if- valueis- null.
 
 - 
getPlaceholderUserValuepublic UserSelectorArg getPlaceholderUserValue() Secondary emails cannot be added to placeholder users.This instance must be tagged as UserAddResult.Tag.PLACEHOLDER_USER.- Returns:
- The UserSelectorArgvalue associated with this instance ifisPlaceholderUser()istrue.
- Throws:
- java.lang.IllegalStateException- If- isPlaceholderUser()is- false.
 
 - 
isOtherpublic boolean isOther() - Returns:
- trueif this instance is tagged as- UserAddResult.Tag.OTHER,- falseotherwise.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
toStringMultilinepublic 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
 
 
- 
 
-