Package com.dropbox.core.v2.team

Class ResendSecondaryEmailResult

  • public final class ResendSecondaryEmailResult
extends java.lang.Object
    Result of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. 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 ResendSecondaryEmailResult 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 ResendSecondaryEmailResult.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 ResendSecondaryEmailResult.

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

        Returns:
        the tag for this instance.

      • success

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

        A verification email was successfully sent to the secondary email address.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of ResendSecondaryEmailResult with its tag set to ResendSecondaryEmailResult.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()
        A verification email was successfully sent to the secondary email address.

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

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

      • notPending

        public static ResendSecondaryEmailResult notPending​(java.lang.String value)
        Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.Tag.NOT_PENDING.

        This secondary email address is not pending for the user.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of ResendSecondaryEmailResult with its tag set to ResendSecondaryEmailResult.Tag.NOT_PENDING.
        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.

      • getNotPendingValue

        public java.lang.String getNotPendingValue()
        This secondary email address is not pending for the user.

        This instance must be tagged as ResendSecondaryEmailResult.Tag.NOT_PENDING.

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

      • rateLimited

        public static ResendSecondaryEmailResult rateLimited​(java.lang.String value)
        Returns an instance of ResendSecondaryEmailResult that has its tag set to ResendSecondaryEmailResult.Tag.RATE_LIMITED.

        Too many emails are being sent to this email address. Please try again later.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of ResendSecondaryEmailResult with its tag set to ResendSecondaryEmailResult.Tag.RATE_LIMITED.
        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.

      • getRateLimitedValue

        public java.lang.String getRateLimitedValue()
        Too many emails are being sent to this email address. Please try again later.

        This instance must be tagged as ResendSecondaryEmailResult.Tag.RATE_LIMITED.

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

      • 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