Package com.dropbox.core.v2.sharing

Class CreateSharedLinkWithSettingsError

java.lang.Object

com.dropbox.core.v2.sharing.CreateSharedLinkWithSettingsError

public final class CreateSharedLinkWithSettingsError
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	CreateSharedLinkWithSettingsError.Tag	Discriminating tag type for CreateSharedLinkWithSettingsError.

Field Summary

Fields

Modifier and Type	Field	Description
static final CreateSharedLinkWithSettingsError	ACCESS_DENIED	The user is not allowed to create a shared link to the specified file.
static final CreateSharedLinkWithSettingsError	BANNED_MEMBER	The current user has been banned for abuse reasons.
static final CreateSharedLinkWithSettingsError	EMAIL_NOT_VERIFIED	This user's email address is not verified.
static final CreateSharedLinkWithSettingsError	TOO_MANY_SHARED_FOLDERS	Your Dropbox folder will have too many shared folders after the operation.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookupError	getPathValue()	This instance must be tagged as CreateSharedLinkWithSettingsError.Tag.PATH.
SharedLinkSettingsError	getSettingsErrorValue()	There is an error with the given settings.
SharedLinkAlreadyExistsMetadata	getSharedLinkAlreadyExistsValue()	The shared link already exists.
int	hashCode()
boolean	isAccessDenied()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.ACCESS_DENIED, false otherwise.
boolean	isBannedMember()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.BANNED_MEMBER, false otherwise.
boolean	isEmailNotVerified()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.EMAIL_NOT_VERIFIED, false otherwise.
boolean	isPath()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.PATH, false otherwise.
boolean	isSettingsError()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.SETTINGS_ERROR, false otherwise.
boolean	isSharedLinkAlreadyExists()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS, false otherwise.
boolean	isTooManySharedFolders()	Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.TOO_MANY_SHARED_FOLDERS, false otherwise.
static CreateSharedLinkWithSettingsError	path(LookupError value)	Returns an instance of CreateSharedLinkWithSettingsError that has its tag set to CreateSharedLinkWithSettingsError.Tag.PATH.
static CreateSharedLinkWithSettingsError	settingsError(SharedLinkSettingsError value)	Returns an instance of CreateSharedLinkWithSettingsError that has its tag set to CreateSharedLinkWithSettingsError.Tag.SETTINGS_ERROR.
static CreateSharedLinkWithSettingsError	sharedLinkAlreadyExists()	Returns an instance of CreateSharedLinkWithSettingsError that has its tag set to CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.
static CreateSharedLinkWithSettingsError	sharedLinkAlreadyExists(SharedLinkAlreadyExistsMetadata value)	Returns an instance of CreateSharedLinkWithSettingsError that has its tag set to CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.
CreateSharedLinkWithSettingsError.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 CreateSharedLinkWithSettingsError 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.

ACCESS_DENIED

public static final CreateSharedLinkWithSettingsError ACCESS_DENIED

The user is not allowed to create a shared link to the specified file. For example, this can occur if the file is restricted or if the user's links are banned.

BANNED_MEMBER

public static final CreateSharedLinkWithSettingsError BANNED_MEMBER

The current user has been banned for abuse reasons.

TOO_MANY_SHARED_FOLDERS

public static final CreateSharedLinkWithSettingsError TOO_MANY_SHARED_FOLDERS

Your Dropbox folder will have too many shared folders after the operation. https://help.dropbox.com/share/shared-folder-faq#Is-there-a-limit-to-the-number-of-shared-folders-I-can-create

Method Details

tag

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

Returns:

the tag for this instance.

isPath

public boolean isPath()

Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.PATH, false otherwise.

Returns:

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

path

public static CreateSharedLinkWithSettingsError path(LookupError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

This instance must be tagged as CreateSharedLinkWithSettingsError.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 CreateSharedLinkWithSettingsError.Tag.EMAIL_NOT_VERIFIED, false otherwise.

Returns:

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

isSharedLinkAlreadyExists

public boolean isSharedLinkAlreadyExists()

Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS, false otherwise.

Returns:

true if this instance is tagged as CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS, false otherwise.

sharedLinkAlreadyExists

public static CreateSharedLinkWithSettingsError sharedLinkAlreadyExists(SharedLinkAlreadyExistsMetadata value)

Returns an instance of CreateSharedLinkWithSettingsError that has its tag set to CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.

The shared link already exists. You can call DbxUserSharingRequests.listSharedLinks(com.dropbox.core.v2.sharing.ListSharedLinksArg) to get the existing link, or use the provided metadata if it is returned. Existing link metadata will not be returned if custom settings were specified in the request that could make the existing link incompatible with the requested settings.

Parameters:

value - value to assign to this instance.

Returns:

Instance of CreateSharedLinkWithSettingsError with its tag set to CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.

sharedLinkAlreadyExists

public static CreateSharedLinkWithSettingsError sharedLinkAlreadyExists()

Returns an instance of CreateSharedLinkWithSettingsError that has its tag set to CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.

The shared link already exists. You can call DbxUserSharingRequests.listSharedLinks(com.dropbox.core.v2.sharing.ListSharedLinksArg) to get the existing link, or use the provided metadata if it is returned. Existing link metadata will not be returned if custom settings were specified in the request that could make the existing link incompatible with the requested settings.

Returns:

Instance of CreateSharedLinkWithSettingsError with its tag set to CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.

getSharedLinkAlreadyExistsValue

public SharedLinkAlreadyExistsMetadata getSharedLinkAlreadyExistsValue()

The shared link already exists. You can call DbxUserSharingRequests.listSharedLinks(com.dropbox.core.v2.sharing.ListSharedLinksArg) to get the existing link, or use the provided metadata if it is returned. Existing link metadata will not be returned if custom settings were specified in the request that could make the existing link incompatible with the requested settings.

This instance must be tagged as CreateSharedLinkWithSettingsError.Tag.SHARED_LINK_ALREADY_EXISTS.

Returns:

The SharedLinkAlreadyExistsMetadata value associated with this instance if isSharedLinkAlreadyExists() is true.

Throws:

IllegalStateException - If isSharedLinkAlreadyExists() is false.

isSettingsError

public boolean isSettingsError()

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

Returns:

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

settingsError

public static CreateSharedLinkWithSettingsError settingsError(SharedLinkSettingsError value)

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

There is an error with the given settings.

Parameters:

value - value to assign to this instance.

Returns:

Instance of CreateSharedLinkWithSettingsError with its tag set to CreateSharedLinkWithSettingsError.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 CreateSharedLinkWithSettingsError.Tag.SETTINGS_ERROR.

Returns:

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

Throws:

IllegalStateException - If isSettingsError() is false.

isAccessDenied

public boolean isAccessDenied()

Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.ACCESS_DENIED, false otherwise.

Returns:

true if this instance is tagged as CreateSharedLinkWithSettingsError.Tag.ACCESS_DENIED, false otherwise.

isBannedMember

public boolean isBannedMember()

Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.BANNED_MEMBER, false otherwise.

Returns:

true if this instance is tagged as CreateSharedLinkWithSettingsError.Tag.BANNED_MEMBER, false otherwise.

isTooManySharedFolders

public boolean isTooManySharedFolders()

Returns true if this instance has the tag CreateSharedLinkWithSettingsError.Tag.TOO_MANY_SHARED_FOLDERS, false otherwise.

Returns:

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