Package com.dropbox.core.v2.sharing

Class RelinquishFolderMembershipError

java.lang.Object

com.dropbox.core.v2.sharing.RelinquishFolderMembershipError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final RelinquishFolderMembershipError	FOLDER_OWNER	The current user is the owner of the shared folder.
static final RelinquishFolderMembershipError	GROUP_ACCESS	The current user has access to the shared folder via a group.
static final RelinquishFolderMembershipError	MOUNTED	The shared folder is currently mounted.
static final RelinquishFolderMembershipError	NO_EXPLICIT_ACCESS	The current user only has inherited access to the shared folder.
static final RelinquishFolderMembershipError	NO_PERMISSION	The current user does not have permission to perform this action.
static final RelinquishFolderMembershipError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final RelinquishFolderMembershipError	TEAM_FOLDER	This action cannot be performed on a team shared folder.

Method Summary

Modifier and Type	Method	Description
static RelinquishFolderMembershipError	accessError(SharedFolderAccessError value)	Returns an instance of RelinquishFolderMembershipError that has its tag set to RelinquishFolderMembershipError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharedFolderAccessError	getAccessErrorValue()	This instance must be tagged as RelinquishFolderMembershipError.Tag.ACCESS_ERROR.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.ACCESS_ERROR, false otherwise.
boolean	isFolderOwner()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.FOLDER_OWNER, false otherwise.
boolean	isGroupAccess()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.GROUP_ACCESS, false otherwise.
boolean	isMounted()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.MOUNTED, false otherwise.
boolean	isNoExplicitAccess()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.OTHER, false otherwise.
boolean	isTeamFolder()	Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.TEAM_FOLDER, false otherwise.
RelinquishFolderMembershipError.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

FOLDER_OWNER

public static final RelinquishFolderMembershipError FOLDER_OWNER

The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first.

MOUNTED

public static final RelinquishFolderMembershipError MOUNTED

The shared folder is currently mounted. Unmount the shared folder before relinquishing membership.

GROUP_ACCESS

public static final RelinquishFolderMembershipError GROUP_ACCESS

The current user has access to the shared folder via a group. You can't relinquish membership to folders shared via groups.

TEAM_FOLDER

public static final RelinquishFolderMembershipError TEAM_FOLDER

This action cannot be performed on a team shared folder.

NO_PERMISSION

public static final RelinquishFolderMembershipError NO_PERMISSION

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

NO_EXPLICIT_ACCESS

public static final RelinquishFolderMembershipError NO_EXPLICIT_ACCESS

The current user only has inherited access to the shared folder. You can't relinquish inherited membership to folders.

OTHER

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

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

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

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

Returns:

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

accessError

public static RelinquishFolderMembershipError accessError(SharedFolderAccessError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharedFolderAccessError getAccessErrorValue()

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

Returns:

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

Throws:

IllegalStateException - If isAccessError() is false.

isFolderOwner

public boolean isFolderOwner()

Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.FOLDER_OWNER, false otherwise.

Returns:

true if this instance is tagged as RelinquishFolderMembershipError.Tag.FOLDER_OWNER, false otherwise.

isMounted

public boolean isMounted()

Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.MOUNTED, false otherwise.

Returns:

true if this instance is tagged as RelinquishFolderMembershipError.Tag.MOUNTED, false otherwise.

isGroupAccess

public boolean isGroupAccess()

Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.GROUP_ACCESS, false otherwise.

Returns:

true if this instance is tagged as RelinquishFolderMembershipError.Tag.GROUP_ACCESS, false otherwise.

isTeamFolder

public boolean isTeamFolder()

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

Returns:

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

isNoPermission

public boolean isNoPermission()

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

Returns:

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

isNoExplicitAccess

public boolean isNoExplicitAccess()

Returns true if this instance has the tag RelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS, false otherwise.

Returns:

true if this instance is tagged as RelinquishFolderMembershipError.Tag.NO_EXPLICIT_ACCESS, false otherwise.

isOther

public boolean isOther()

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

Returns:

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