Class GetTemporaryLinkError
- java.lang.Object
-
- com.dropbox.core.v2.files.GetTemporaryLinkError
-
public final class GetTemporaryLinkError extends java.lang.ObjectThis class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()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 Summary
Nested Classes Modifier and Type Class Description static classGetTemporaryLinkError.TagDiscriminating tag type forGetTemporaryLinkError.
-
Field Summary
Fields Modifier and Type Field Description static GetTemporaryLinkErrorEMAIL_NOT_VERIFIEDThis user's email address is not verified.static GetTemporaryLinkErrorNOT_ALLOWEDThe user is not allowed to request a temporary link to the specified file.static GetTemporaryLinkErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static GetTemporaryLinkErrorUNSUPPORTED_FILECannot get temporary link to this file type; useDbxUserFilesRequests.export(String,String)instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)LookupErrorgetPathValue()This instance must be tagged asGetTemporaryLinkError.Tag.PATH.inthashCode()booleanisEmailNotVerified()Returnstrueif this instance has the tagGetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED,falseotherwise.booleanisNotAllowed()booleanisOther()booleanisPath()booleanisUnsupportedFile()Returnstrueif this instance has the tagGetTemporaryLinkError.Tag.UNSUPPORTED_FILE,falseotherwise.static GetTemporaryLinkErrorpath(LookupError value)Returns an instance ofGetTemporaryLinkErrorthat has its tag set toGetTemporaryLinkError.Tag.PATH.GetTemporaryLinkError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
EMAIL_NOT_VERIFIED
public static final GetTemporaryLinkError EMAIL_NOT_VERIFIED
This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.
-
UNSUPPORTED_FILE
public static final GetTemporaryLinkError UNSUPPORTED_FILE
Cannot get temporary link to this file type; useDbxUserFilesRequests.export(String,String)instead.
-
NOT_ALLOWED
public static final GetTemporaryLinkError NOT_ALLOWED
The user is not allowed to request a temporary link to the specified file. For example, this can occur if the file is restricted or if the user's links are banned.
-
OTHER
public static final GetTemporaryLinkError 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 GetTemporaryLinkError.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 thisGetTemporaryLinkError.If a tag returned by the server is unrecognized by this SDK, the
GetTemporaryLinkError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
trueif this instance is tagged asGetTemporaryLinkError.Tag.PATH,falseotherwise.
-
path
public static GetTemporaryLinkError path(LookupError value)
Returns an instance ofGetTemporaryLinkErrorthat has its tag set toGetTemporaryLinkError.Tag.PATH.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
GetTemporaryLinkErrorwith its tag set toGetTemporaryLinkError.Tag.PATH. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asGetTemporaryLinkError.Tag.PATH.- Returns:
- The
LookupErrorvalue associated with this instance ifisPath()istrue. - Throws:
java.lang.IllegalStateException- IfisPath()isfalse.
-
isEmailNotVerified
public boolean isEmailNotVerified()
Returnstrueif this instance has the tagGetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED,falseotherwise.- Returns:
trueif this instance is tagged asGetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED,falseotherwise.
-
isUnsupportedFile
public boolean isUnsupportedFile()
Returnstrueif this instance has the tagGetTemporaryLinkError.Tag.UNSUPPORTED_FILE,falseotherwise.- Returns:
trueif this instance is tagged asGetTemporaryLinkError.Tag.UNSUPPORTED_FILE,falseotherwise.
-
isNotAllowed
public boolean isNotAllowed()
- Returns:
trueif this instance is tagged asGetTemporaryLinkError.Tag.NOT_ALLOWED,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asGetTemporaryLinkError.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.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
-
-