Class InviteeInfo


  • public final class InviteeInfo
    extends java.lang.Object
    Information about the recipient of a shared content invitation.

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

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

        Returns:
        the tag for this instance.
      • email

        public static InviteeInfo email​(java.lang.String value)
        Returns an instance of InviteeInfo that has its tag set to InviteeInfo.Tag.EMAIL.

        Email address of invited user.

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

        public java.lang.String getEmailValue()
        Email address of invited user.

        This instance must be tagged as InviteeInfo.Tag.EMAIL.

        Returns:
        The String value associated with this instance if isEmail() is true.
        Throws:
        java.lang.IllegalStateException - If isEmail() 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