Package com.dropbox.core.v2.sharing

Class TransferFolderError

java.lang.Object

com.dropbox.core.v2.sharing.TransferFolderError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TransferFolderError	INVALID_DROPBOX_ID	TransferFolderArg.getToDropboxId() is invalid.
static final TransferFolderError	NEW_OWNER_EMAIL_UNVERIFIED	The new designated owner's email address is not verified.
static final TransferFolderError	NEW_OWNER_NOT_A_MEMBER	The new designated owner is not currently a member of the shared folder.
static final TransferFolderError	NEW_OWNER_UNMOUNTED	The new designated owner has not added the folder to their Dropbox.
static final TransferFolderError	NO_PERMISSION	The current user does not have permission to perform this action.
static final TransferFolderError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final TransferFolderError	TEAM_FOLDER	This action cannot be performed on a team shared folder.

Method Summary

Modifier and Type	Method	Description
static TransferFolderError	accessError(SharedFolderAccessError value)	Returns an instance of TransferFolderError that has its tag set to TransferFolderError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharedFolderAccessError	getAccessErrorValue()	This instance must be tagged as TransferFolderError.Tag.ACCESS_ERROR.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag TransferFolderError.Tag.ACCESS_ERROR, false otherwise.
boolean	isInvalidDropboxId()	Returns true if this instance has the tag TransferFolderError.Tag.INVALID_DROPBOX_ID, false otherwise.
boolean	isNewOwnerEmailUnverified()	Returns true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED, false otherwise.
boolean	isNewOwnerNotAMember()	Returns true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER, false otherwise.
boolean	isNewOwnerUnmounted()	Returns true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_UNMOUNTED, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag TransferFolderError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag TransferFolderError.Tag.OTHER, false otherwise.
boolean	isTeamFolder()	Returns true if this instance has the tag TransferFolderError.Tag.TEAM_FOLDER, false otherwise.
TransferFolderError.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

INVALID_DROPBOX_ID

public static final TransferFolderError INVALID_DROPBOX_ID

TransferFolderArg.getToDropboxId() is invalid.

NEW_OWNER_NOT_A_MEMBER

public static final TransferFolderError NEW_OWNER_NOT_A_MEMBER

The new designated owner is not currently a member of the shared folder.

NEW_OWNER_UNMOUNTED

public static final TransferFolderError NEW_OWNER_UNMOUNTED

The new designated owner has not added the folder to their Dropbox.

NEW_OWNER_EMAIL_UNVERIFIED

public static final TransferFolderError NEW_OWNER_EMAIL_UNVERIFIED

The new designated owner'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.

TEAM_FOLDER

public static final TransferFolderError TEAM_FOLDER

This action cannot be performed on a team shared folder.

NO_PERMISSION

public static final TransferFolderError NO_PERMISSION

The current user does not have permission to perform this action.

OTHER

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

If a tag returned by the server is unrecognized by this SDK, the TransferFolderError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

Returns true if this instance has the tag TransferFolderError.Tag.ACCESS_ERROR, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.ACCESS_ERROR, false otherwise.

accessError

public static TransferFolderError accessError(SharedFolderAccessError value)

Returns an instance of TransferFolderError that has its tag set to TransferFolderError.Tag.ACCESS_ERROR.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of TransferFolderError with its tag set to TransferFolderError.Tag.ACCESS_ERROR.

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharedFolderAccessError getAccessErrorValue()

This instance must be tagged as TransferFolderError.Tag.ACCESS_ERROR.

Returns:

The SharedFolderAccessError value associated with this instance if isAccessError() is true.

Throws:

IllegalStateException - If isAccessError() is false.

isInvalidDropboxId

public boolean isInvalidDropboxId()

Returns true if this instance has the tag TransferFolderError.Tag.INVALID_DROPBOX_ID, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.INVALID_DROPBOX_ID, false otherwise.

isNewOwnerNotAMember

public boolean isNewOwnerNotAMember()

Returns true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER, false otherwise.

isNewOwnerUnmounted

public boolean isNewOwnerUnmounted()

Returns true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_UNMOUNTED, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.NEW_OWNER_UNMOUNTED, false otherwise.

isNewOwnerEmailUnverified

public boolean isNewOwnerEmailUnverified()

Returns true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED, false otherwise.

isTeamFolder

public boolean isTeamFolder()

Returns true if this instance has the tag TransferFolderError.Tag.TEAM_FOLDER, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.TEAM_FOLDER, false otherwise.

isNoPermission

public boolean isNoPermission()

Returns true if this instance has the tag TransferFolderError.Tag.NO_PERMISSION, false otherwise.

Returns:

true if this instance is tagged as TransferFolderError.Tag.NO_PERMISSION, false otherwise.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as TransferFolderError.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