Package com.dropbox.core.v2.sharing

Class ShareFolderError

java.lang.Object

com.dropbox.core.v2.sharing.ShareFolderError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ShareFolderError	DISALLOWED_SHARED_LINK_POLICY	The current user's account is not allowed to select the specified ShareFolderArgBase.getSharedLinkPolicy().
static final ShareFolderError	EMAIL_UNVERIFIED	This user's email address is not verified.
static final ShareFolderError	NO_PERMISSION	The current user does not have permission to perform this action.
static final ShareFolderError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final ShareFolderError	TEAM_POLICY_DISALLOWS_MEMBER_POLICY	Team policy or group sharing settings are more restrictive than ShareFolderArgBase.getMemberPolicy().

Method Summary

Modifier and Type	Method	Description
static ShareFolderError	badPath(SharePathError value)	Returns an instance of ShareFolderError that has its tag set to ShareFolderError.Tag.BAD_PATH.
boolean	equals(Object obj)
SharePathError	getBadPathValue()	ShareFolderArgBase.getPath() is invalid.
int	hashCode()
boolean	isBadPath()	Returns true if this instance has the tag ShareFolderError.Tag.BAD_PATH, false otherwise.
boolean	isDisallowedSharedLinkPolicy()	Returns true if this instance has the tag ShareFolderError.Tag.DISALLOWED_SHARED_LINK_POLICY, false otherwise.
boolean	isEmailUnverified()	Returns true if this instance has the tag ShareFolderError.Tag.EMAIL_UNVERIFIED, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag ShareFolderError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag ShareFolderError.Tag.OTHER, false otherwise.
boolean	isTeamPolicyDisallowsMemberPolicy()	Returns true if this instance has the tag ShareFolderError.Tag.TEAM_POLICY_DISALLOWS_MEMBER_POLICY, false otherwise.
ShareFolderError.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_UNVERIFIED

public static final ShareFolderError EMAIL_UNVERIFIED

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.

TEAM_POLICY_DISALLOWS_MEMBER_POLICY

public static final ShareFolderError TEAM_POLICY_DISALLOWS_MEMBER_POLICY

Team policy or group sharing settings are more restrictive than ShareFolderArgBase.getMemberPolicy().

DISALLOWED_SHARED_LINK_POLICY

public static final ShareFolderError DISALLOWED_SHARED_LINK_POLICY

The current user's account is not allowed to select the specified ShareFolderArgBase.getSharedLinkPolicy().

OTHER

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

NO_PERMISSION

public static final ShareFolderError NO_PERMISSION

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

Method Details

tag

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

Returns:

the tag for this instance.

isEmailUnverified

public boolean isEmailUnverified()

Returns true if this instance has the tag ShareFolderError.Tag.EMAIL_UNVERIFIED, false otherwise.

Returns:

true if this instance is tagged as ShareFolderError.Tag.EMAIL_UNVERIFIED, false otherwise.

isBadPath

public boolean isBadPath()

Returns true if this instance has the tag ShareFolderError.Tag.BAD_PATH, false otherwise.

Returns:

true if this instance is tagged as ShareFolderError.Tag.BAD_PATH, false otherwise.

badPath

public static ShareFolderError badPath(SharePathError value)

Returns an instance of ShareFolderError that has its tag set to ShareFolderError.Tag.BAD_PATH.

ShareFolderArgBase.getPath() is invalid.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ShareFolderError with its tag set to ShareFolderError.Tag.BAD_PATH.

Throws:

IllegalArgumentException - if value is null.

getBadPathValue

public SharePathError getBadPathValue()

ShareFolderArgBase.getPath() is invalid.

This instance must be tagged as ShareFolderError.Tag.BAD_PATH.

Returns:

The SharePathError value associated with this instance if isBadPath() is true.

Throws:

IllegalStateException - If isBadPath() is false.

isTeamPolicyDisallowsMemberPolicy

public boolean isTeamPolicyDisallowsMemberPolicy()

Returns true if this instance has the tag ShareFolderError.Tag.TEAM_POLICY_DISALLOWS_MEMBER_POLICY, false otherwise.

Returns:

true if this instance is tagged as ShareFolderError.Tag.TEAM_POLICY_DISALLOWS_MEMBER_POLICY, false otherwise.

isDisallowedSharedLinkPolicy

public boolean isDisallowedSharedLinkPolicy()

Returns true if this instance has the tag ShareFolderError.Tag.DISALLOWED_SHARED_LINK_POLICY, false otherwise.

Returns:

true if this instance is tagged as ShareFolderError.Tag.DISALLOWED_SHARED_LINK_POLICY, false otherwise.

isOther

public boolean isOther()

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

Returns:

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

isNoPermission

public boolean isNoPermission()

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

Returns:

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