Package com.dropbox.core.v2.sharing

Class ModifySharedLinkSettingsError

java.lang.Object

com.dropbox.core.v2.sharing.ModifySharedLinkSettingsError

public final class ModifySharedLinkSettingsError
extends Object

This class is a 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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ModifySharedLinkSettingsError	EMAIL_NOT_VERIFIED	This user's email address is not verified.
static final ModifySharedLinkSettingsError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final ModifySharedLinkSettingsError	SHARED_LINK_ACCESS_DENIED	The caller is not allowed to access this shared link.
static final ModifySharedLinkSettingsError	SHARED_LINK_NOT_FOUND	The shared link wasn't found.
static final ModifySharedLinkSettingsError	UNSUPPORTED_LINK_TYPE	This type of link is not supported; use DbxUserFilesRequests.export(String,String) instead.
static final ModifySharedLinkSettingsError	UNSUPPORTED_PARAMETER_FIELD	Private shared links do not support `path` or `link_password` parameter fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SharedLinkSettingsError	getSettingsErrorValue()	There is an error with the given settings.
int	hashCode()
boolean	isEmailNotVerified()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.EMAIL_NOT_VERIFIED, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.OTHER, false otherwise.
boolean	isSettingsError()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR, false otherwise.
boolean	isSharedLinkAccessDenied()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.SHARED_LINK_ACCESS_DENIED, false otherwise.
boolean	isSharedLinkNotFound()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.SHARED_LINK_NOT_FOUND, false otherwise.
boolean	isUnsupportedLinkType()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.UNSUPPORTED_LINK_TYPE, false otherwise.
boolean	isUnsupportedParameterField()	Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.UNSUPPORTED_PARAMETER_FIELD, false otherwise.
static ModifySharedLinkSettingsError	settingsError(SharedLinkSettingsError value)	Returns an instance of ModifySharedLinkSettingsError that has its tag set to ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR.
ModifySharedLinkSettingsError.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

SHARED_LINK_NOT_FOUND

public static final ModifySharedLinkSettingsError SHARED_LINK_NOT_FOUND

The shared link wasn't found.

SHARED_LINK_ACCESS_DENIED

public static final ModifySharedLinkSettingsError SHARED_LINK_ACCESS_DENIED

The caller is not allowed to access this shared link.

UNSUPPORTED_LINK_TYPE

public static final ModifySharedLinkSettingsError UNSUPPORTED_LINK_TYPE

This type of link is not supported; use DbxUserFilesRequests.export(String,String) instead.

UNSUPPORTED_PARAMETER_FIELD

public static final ModifySharedLinkSettingsError UNSUPPORTED_PARAMETER_FIELD

Private shared links do not support `path` or `link_password` parameter fields.

OTHER

public static final ModifySharedLinkSettingsError 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.

EMAIL_NOT_VERIFIED

public static final ModifySharedLinkSettingsError 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.

Method Details

tag

public ModifySharedLinkSettingsError.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 ModifySharedLinkSettingsError.

Returns:

the tag for this instance.

isSharedLinkNotFound

public boolean isSharedLinkNotFound()

Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.SHARED_LINK_NOT_FOUND, false otherwise.

Returns:

true if this instance is tagged as ModifySharedLinkSettingsError.Tag.SHARED_LINK_NOT_FOUND, false otherwise.

isSharedLinkAccessDenied

public boolean isSharedLinkAccessDenied()

Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.SHARED_LINK_ACCESS_DENIED, false otherwise.

Returns:

true if this instance is tagged as ModifySharedLinkSettingsError.Tag.SHARED_LINK_ACCESS_DENIED, false otherwise.

isUnsupportedLinkType

public boolean isUnsupportedLinkType()

Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.UNSUPPORTED_LINK_TYPE, false otherwise.

Returns:

true if this instance is tagged as ModifySharedLinkSettingsError.Tag.UNSUPPORTED_LINK_TYPE, false otherwise.

isUnsupportedParameterField

public boolean isUnsupportedParameterField()

Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.UNSUPPORTED_PARAMETER_FIELD, false otherwise.

Returns:

true if this instance is tagged as ModifySharedLinkSettingsError.Tag.UNSUPPORTED_PARAMETER_FIELD, false otherwise.

isOther

public boolean isOther()

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

Returns:

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

isSettingsError

public boolean isSettingsError()

Returns true if this instance has the tag ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR, false otherwise.

Returns:

true if this instance is tagged as ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR, false otherwise.

settingsError

public static ModifySharedLinkSettingsError settingsError(SharedLinkSettingsError value)

Returns an instance of ModifySharedLinkSettingsError that has its tag set to ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR.

There is an error with the given settings.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ModifySharedLinkSettingsError with its tag set to ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR.

Throws:

IllegalArgumentException - if value is null.

getSettingsErrorValue

public SharedLinkSettingsError getSettingsErrorValue()

There is an error with the given settings.

This instance must be tagged as ModifySharedLinkSettingsError.Tag.SETTINGS_ERROR.

Returns:

The SharedLinkSettingsError value associated with this instance if isSettingsError() is true.

Throws:

IllegalStateException - If isSettingsError() is false.

isEmailNotVerified

public boolean isEmailNotVerified()

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

Returns:

true if this instance is tagged as ModifySharedLinkSettingsError.Tag.EMAIL_NOT_VERIFIED, 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