Class GetTemporaryLinkError
- java.lang.Object
-
- com.dropbox.core.v2.files.GetTemporaryLinkError
-
public final class GetTemporaryLinkError extends java.lang.Object
This 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
OTHER
value will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetTemporaryLinkError.Tag
Discriminating tag type forGetTemporaryLinkError
.
-
Field Summary
Fields Modifier and Type Field Description static GetTemporaryLinkError
EMAIL_NOT_VERIFIED
This user's email address is not verified.static GetTemporaryLinkError
NOT_ALLOWED
The user is not allowed to request a temporary link to the specified file.static GetTemporaryLinkError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static GetTemporaryLinkError
UNSUPPORTED_FILE
Cannot 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 boolean
equals(java.lang.Object obj)
LookupError
getPathValue()
This instance must be tagged asGetTemporaryLinkError.Tag.PATH
.int
hashCode()
boolean
isEmailNotVerified()
Returnstrue
if this instance has the tagGetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED
,false
otherwise.boolean
isNotAllowed()
boolean
isOther()
boolean
isPath()
boolean
isUnsupportedFile()
Returnstrue
if this instance has the tagGetTemporaryLinkError.Tag.UNSUPPORTED_FILE
,false
otherwise.static GetTemporaryLinkError
path(LookupError value)
Returns an instance ofGetTemporaryLinkError
that has its tag set toGetTemporaryLinkError.Tag.PATH
.GetTemporaryLinkError.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
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 aswitch
statement to properly handle the different values for thisGetTemporaryLinkError
.If a tag returned by the server is unrecognized by this SDK, the
GetTemporaryLinkError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
true
if this instance is tagged asGetTemporaryLinkError.Tag.PATH
,false
otherwise.
-
path
public static GetTemporaryLinkError path(LookupError value)
Returns an instance ofGetTemporaryLinkError
that has its tag set toGetTemporaryLinkError.Tag.PATH
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
GetTemporaryLinkError
with its tag set toGetTemporaryLinkError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asGetTemporaryLinkError.Tag.PATH
.- Returns:
- The
LookupError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isEmailNotVerified
public boolean isEmailNotVerified()
Returnstrue
if this instance has the tagGetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED
,false
otherwise.- Returns:
true
if this instance is tagged asGetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED
,false
otherwise.
-
isUnsupportedFile
public boolean isUnsupportedFile()
Returnstrue
if this instance has the tagGetTemporaryLinkError.Tag.UNSUPPORTED_FILE
,false
otherwise.- Returns:
true
if this instance is tagged asGetTemporaryLinkError.Tag.UNSUPPORTED_FILE
,false
otherwise.
-
isNotAllowed
public boolean isNotAllowed()
- Returns:
true
if this instance is tagged asGetTemporaryLinkError.Tag.NOT_ALLOWED
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asGetTemporaryLinkError.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in 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
-
-