Class 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 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.

    • 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 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.
      • 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:
        java.lang.IllegalArgumentException - if value is null.
      • 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:
        java.lang.IllegalArgumentException - if value is null.
      • 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:
        java.lang.IllegalArgumentException - if value is null.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.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