Package com.dropbox.core.v2.sharing

Class FileMemberActionError

java.lang.Object

com.dropbox.core.v2.sharing.FileMemberActionError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final FileMemberActionError	INVALID_MEMBER	Specified member was not found.
static final FileMemberActionError	NO_PERMISSION	User does not have permission to perform this action on this member.
static final FileMemberActionError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static FileMemberActionError	accessError(SharingFileAccessError value)	Returns an instance of FileMemberActionError that has its tag set to FileMemberActionError.Tag.ACCESS_ERROR.
boolean	equals(Object obj)
SharingFileAccessError	getAccessErrorValue()	Specified file was invalid or user does not have access.
MemberAccessLevelResult	getNoExplicitAccessValue()	The action cannot be completed because the target member does not have explicit access to the file.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag FileMemberActionError.Tag.ACCESS_ERROR, false otherwise.
boolean	isInvalidMember()	Returns true if this instance has the tag FileMemberActionError.Tag.INVALID_MEMBER, false otherwise.
boolean	isNoExplicitAccess()	Returns true if this instance has the tag FileMemberActionError.Tag.NO_EXPLICIT_ACCESS, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag FileMemberActionError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag FileMemberActionError.Tag.OTHER, false otherwise.
static FileMemberActionError	noExplicitAccess(MemberAccessLevelResult value)	Returns an instance of FileMemberActionError that has its tag set to FileMemberActionError.Tag.NO_EXPLICIT_ACCESS.
FileMemberActionError.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_MEMBER

public static final FileMemberActionError INVALID_MEMBER

Specified member was not found.

NO_PERMISSION

public static final FileMemberActionError NO_PERMISSION

User does not have permission to perform this action on this member.

OTHER

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

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

Returns:

the tag for this instance.

isInvalidMember

public boolean isInvalidMember()

Returns true if this instance has the tag FileMemberActionError.Tag.INVALID_MEMBER, false otherwise.

Returns:

true if this instance is tagged as FileMemberActionError.Tag.INVALID_MEMBER, false otherwise.

isNoPermission

public boolean isNoPermission()

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

Returns:

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

isAccessError

public boolean isAccessError()

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

Returns:

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

accessError

public static FileMemberActionError accessError(SharingFileAccessError value)

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

Specified file was invalid or user does not have access.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharingFileAccessError getAccessErrorValue()

Specified file was invalid or user does not have access.

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

Returns:

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

Throws:

IllegalStateException - If isAccessError() is false.

isNoExplicitAccess

public boolean isNoExplicitAccess()

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

Returns:

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

noExplicitAccess

public static FileMemberActionError noExplicitAccess(MemberAccessLevelResult value)

Returns an instance of FileMemberActionError that has its tag set to FileMemberActionError.Tag.NO_EXPLICIT_ACCESS.

The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileMemberActionError with its tag set to FileMemberActionError.Tag.NO_EXPLICIT_ACCESS.

Throws:

IllegalArgumentException - if value is null.

getNoExplicitAccessValue

public MemberAccessLevelResult getNoExplicitAccessValue()

The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

This instance must be tagged as FileMemberActionError.Tag.NO_EXPLICIT_ACCESS.

Returns:

The MemberAccessLevelResult value associated with this instance if isNoExplicitAccess() is true.

Throws:

IllegalStateException - If isNoExplicitAccess() is false.

isOther

public boolean isOther()

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

Returns:

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