Class DeleteSecondaryEmailResult


  • public final class DeleteSecondaryEmailResult
    extends java.lang.Object
    Result of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email 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 DeleteSecondaryEmailResult 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 DeleteSecondaryEmailResult.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 DeleteSecondaryEmailResult.

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

        Returns:
        the tag for this instance.
      • success

        public static DeleteSecondaryEmailResult success​(java.lang.String value)
        Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.SUCCESS.

        The secondary email was successfully deleted.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of DeleteSecondaryEmailResult with its tag set to DeleteSecondaryEmailResult.Tag.SUCCESS.
        Throws:
        java.lang.IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.
      • getSuccessValue

        public java.lang.String getSuccessValue()
        The secondary email was successfully deleted.

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

        Returns:
        The String value associated with this instance if isSuccess() is true.
        Throws:
        java.lang.IllegalStateException - If isSuccess() is false.
      • notFound

        public static DeleteSecondaryEmailResult notFound​(java.lang.String value)
        Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.NOT_FOUND.

        The email address was not found for the user.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of DeleteSecondaryEmailResult with its tag set to DeleteSecondaryEmailResult.Tag.NOT_FOUND.
        Throws:
        java.lang.IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or is null.
      • getNotFoundValue

        public java.lang.String getNotFoundValue()
        The email address was not found for the user.

        This instance must be tagged as DeleteSecondaryEmailResult.Tag.NOT_FOUND.

        Returns:
        The String value associated with this instance if isNotFound() is true.
        Throws:
        java.lang.IllegalStateException - If isNotFound() is false.
      • cannotRemovePrimary

        public static DeleteSecondaryEmailResult cannotRemovePrimary​(java.lang.String value)
        Returns an instance of DeleteSecondaryEmailResult that has its tag set to DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.

        The email address is the primary email address of the user, and cannot be removed.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of DeleteSecondaryEmailResult with its tag set to DeleteSecondaryEmailResult.Tag.CANNOT_REMOVE_PRIMARY.
        Throws:
        java.lang.IllegalArgumentException - if value is longer than 255, does not match pattern " ^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\\.[A-Za-z]{2,15}$", or 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