Package com.dropbox.core.v2.files

Class GetTemporaryLinkError

java.lang.Object

com.dropbox.core.v2.files.GetTemporaryLinkError

public final class GetTemporaryLinkError
extends Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GetTemporaryLinkError.Tag	Discriminating tag type for GetTemporaryLinkError.

Field Summary

Fields

Modifier and Type	Field	Description
static final GetTemporaryLinkError	EMAIL_NOT_VERIFIED	This user's email address is not verified.
static final GetTemporaryLinkError	NOT_ALLOWED	The user is not allowed to request a temporary link to the specified file.
static final GetTemporaryLinkError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final GetTemporaryLinkError	UNSUPPORTED_FILE	Cannot get temporary link to this file type; use DbxUserFilesRequests.export(String,String) instead.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookupError	getPathValue()	This instance must be tagged as GetTemporaryLinkError.Tag.PATH.
int	hashCode()
boolean	isEmailNotVerified()	Returns true if this instance has the tag GetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED, false otherwise.
boolean	isNotAllowed()	Returns true if this instance has the tag GetTemporaryLinkError.Tag.NOT_ALLOWED, false otherwise.
boolean	isOther()	Returns true if this instance has the tag GetTemporaryLinkError.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag GetTemporaryLinkError.Tag.PATH, false otherwise.
boolean	isUnsupportedFile()	Returns true if this instance has the tag GetTemporaryLinkError.Tag.UNSUPPORTED_FILE, false otherwise.
static GetTemporaryLinkError	path(LookupError value)	Returns an instance of GetTemporaryLinkError that has its tag set to GetTemporaryLinkError.Tag.PATH.
GetTemporaryLinkError.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

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; use DbxUserFilesRequests.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 Details

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this GetTemporaryLinkError.

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 has the tag GetTemporaryLinkError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as GetTemporaryLinkError.Tag.PATH, false otherwise.

path

public static GetTemporaryLinkError path(LookupError value)

Returns an instance of GetTemporaryLinkError that has its tag set to GetTemporaryLinkError.Tag.PATH.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of GetTemporaryLinkError with its tag set to GetTemporaryLinkError.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

This instance must be tagged as GetTemporaryLinkError.Tag.PATH.

Returns:

The LookupError value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isEmailNotVerified

public boolean isEmailNotVerified()

Returns true if this instance has the tag GetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED, false otherwise.

Returns:

true if this instance is tagged as GetTemporaryLinkError.Tag.EMAIL_NOT_VERIFIED, false otherwise.

isUnsupportedFile

public boolean isUnsupportedFile()

Returns true if this instance has the tag GetTemporaryLinkError.Tag.UNSUPPORTED_FILE, false otherwise.

Returns:

true if this instance is tagged as GetTemporaryLinkError.Tag.UNSUPPORTED_FILE, false otherwise.

isNotAllowed

public boolean isNotAllowed()

Returns true if this instance has the tag GetTemporaryLinkError.Tag.NOT_ALLOWED, false otherwise.

Returns:

true if this instance is tagged as GetTemporaryLinkError.Tag.NOT_ALLOWED, false otherwise.

isOther

public boolean isOther()

Returns true if this instance has the tag GetTemporaryLinkError.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as GetTemporaryLinkError.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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