Package com.dropbox.core.v2.sharing

Class AddFolderMemberError

java.lang.Object

com.dropbox.core.v2.sharing.AddFolderMemberError

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

Field Summary

Fields

Modifier and Type	Field	Description
static final AddFolderMemberError	BANNED_MEMBER	The current user has been banned.
static final AddFolderMemberError	CANT_SHARE_OUTSIDE_TEAM	Your team policy does not allow sharing outside of the team.
static final AddFolderMemberError	EMAIL_UNVERIFIED	This user's email address is not verified.
static final AddFolderMemberError	INSUFFICIENT_PLAN	The current user's account doesn't support this action.
static final AddFolderMemberError	INVALID_SHARED_FOLDER	Field is deprecated.
static final AddFolderMemberError	NO_PERMISSION	The current user does not have permission to perform this action.
static final AddFolderMemberError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final AddFolderMemberError	RATE_LIMIT	The current user has hit the limit of invites they can send per day.
static final AddFolderMemberError	TEAM_FOLDER	This action cannot be performed on a team shared folder.
static final AddFolderMemberError	TOO_MANY_INVITEES	The current user is trying to share with too many people at once.

Method Summary

Modifier and Type	Method	Description
static AddFolderMemberError	accessError(SharedFolderAccessError value)	Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.ACCESS_ERROR.
static AddFolderMemberError	badMember(AddMemberSelectorError value)	Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.BAD_MEMBER.
boolean	equals(Object obj)
SharedFolderAccessError	getAccessErrorValue()	Unable to access shared folder.
AddMemberSelectorError	getBadMemberValue()	AddFolderMemberArg.getMembers() contains a bad invitation recipient.
long	getTooManyMembersValue()	The value is the member limit that was reached.
long	getTooManyPendingInvitesValue()	The value is the pending invite limit that was reached.
int	hashCode()
boolean	isAccessError()	Returns true if this instance has the tag AddFolderMemberError.Tag.ACCESS_ERROR, false otherwise.
boolean	isBadMember()	Returns true if this instance has the tag AddFolderMemberError.Tag.BAD_MEMBER, false otherwise.
boolean	isBannedMember()	Returns true if this instance has the tag AddFolderMemberError.Tag.BANNED_MEMBER, false otherwise.
boolean	isCantShareOutsideTeam()	Returns true if this instance has the tag AddFolderMemberError.Tag.CANT_SHARE_OUTSIDE_TEAM, false otherwise.
boolean	isEmailUnverified()	Returns true if this instance has the tag AddFolderMemberError.Tag.EMAIL_UNVERIFIED, false otherwise.
boolean	isInsufficientPlan()	Returns true if this instance has the tag AddFolderMemberError.Tag.INSUFFICIENT_PLAN, false otherwise.
boolean	isInvalidSharedFolder()	Returns true if this instance has the tag AddFolderMemberError.Tag.INVALID_SHARED_FOLDER, false otherwise.
boolean	isNoPermission()	Returns true if this instance has the tag AddFolderMemberError.Tag.NO_PERMISSION, false otherwise.
boolean	isOther()	Returns true if this instance has the tag AddFolderMemberError.Tag.OTHER, false otherwise.
boolean	isRateLimit()	Returns true if this instance has the tag AddFolderMemberError.Tag.RATE_LIMIT, false otherwise.
boolean	isTeamFolder()	Returns true if this instance has the tag AddFolderMemberError.Tag.TEAM_FOLDER, false otherwise.
boolean	isTooManyInvitees()	Returns true if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_INVITEES, false otherwise.
boolean	isTooManyMembers()	Returns true if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_MEMBERS, false otherwise.
boolean	isTooManyPendingInvites()	Returns true if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES, false otherwise.
AddFolderMemberError.Tag	tag()	Returns the tag for this instance.
static AddFolderMemberError	tooManyMembers(long value)	Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.TOO_MANY_MEMBERS.
static AddFolderMemberError	tooManyPendingInvites(long value)	Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES.
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 AddFolderMemberError 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.

BANNED_MEMBER

public static final AddFolderMemberError BANNED_MEMBER

The current user has been banned.

CANT_SHARE_OUTSIDE_TEAM

public static final AddFolderMemberError CANT_SHARE_OUTSIDE_TEAM

Your team policy does not allow sharing outside of the team.

RATE_LIMIT

public static final AddFolderMemberError RATE_LIMIT

The current user has hit the limit of invites they can send per day. Try again in 24 hours.

TOO_MANY_INVITEES

public static final AddFolderMemberError TOO_MANY_INVITEES

The current user is trying to share with too many people at once.

INSUFFICIENT_PLAN

public static final AddFolderMemberError INSUFFICIENT_PLAN

The current user's account doesn't support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan.

TEAM_FOLDER

public static final AddFolderMemberError TEAM_FOLDER

This action cannot be performed on a team shared folder.

NO_PERMISSION

public static final AddFolderMemberError NO_PERMISSION

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

INVALID_SHARED_FOLDER

public static final AddFolderMemberError INVALID_SHARED_FOLDER

Field is deprecated. Invalid shared folder error will be returned as an access_error.

OTHER

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

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

Returns:

the tag for this instance.

isAccessError

public boolean isAccessError()

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

Returns:

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

accessError

public static AddFolderMemberError accessError(SharedFolderAccessError value)

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

Unable to access shared folder.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getAccessErrorValue

public SharedFolderAccessError getAccessErrorValue()

Unable to access shared folder.

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

Returns:

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

Throws:

IllegalStateException - If isAccessError() is false.

isEmailUnverified

public boolean isEmailUnverified()

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

Returns:

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

isBannedMember

public boolean isBannedMember()

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

Returns:

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

isBadMember

public boolean isBadMember()

Returns true if this instance has the tag AddFolderMemberError.Tag.BAD_MEMBER, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.BAD_MEMBER, false otherwise.

badMember

public static AddFolderMemberError badMember(AddMemberSelectorError value)

Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.BAD_MEMBER.

AddFolderMemberArg.getMembers() contains a bad invitation recipient.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddFolderMemberError with its tag set to AddFolderMemberError.Tag.BAD_MEMBER.

Throws:

IllegalArgumentException - if value is null.

getBadMemberValue

public AddMemberSelectorError getBadMemberValue()

AddFolderMemberArg.getMembers() contains a bad invitation recipient.

This instance must be tagged as AddFolderMemberError.Tag.BAD_MEMBER.

Returns:

The AddMemberSelectorError value associated with this instance if isBadMember() is true.

Throws:

IllegalStateException - If isBadMember() is false.

isCantShareOutsideTeam

public boolean isCantShareOutsideTeam()

Returns true if this instance has the tag AddFolderMemberError.Tag.CANT_SHARE_OUTSIDE_TEAM, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.CANT_SHARE_OUTSIDE_TEAM, false otherwise.

isTooManyMembers

public boolean isTooManyMembers()

Returns true if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_MEMBERS, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.TOO_MANY_MEMBERS, false otherwise.

tooManyMembers

public static AddFolderMemberError tooManyMembers(long value)

Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.TOO_MANY_MEMBERS.

The value is the member limit that was reached.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddFolderMemberError with its tag set to AddFolderMemberError.Tag.TOO_MANY_MEMBERS.

getTooManyMembersValue

public long getTooManyMembersValue()

The value is the member limit that was reached.

This instance must be tagged as AddFolderMemberError.Tag.TOO_MANY_MEMBERS.

Returns:

The

invalid reference

long

value associated with this instance if isTooManyMembers() is true.

Throws:

IllegalStateException - If isTooManyMembers() is false.

isTooManyPendingInvites

public boolean isTooManyPendingInvites()

Returns true if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES, false otherwise.

tooManyPendingInvites

public static AddFolderMemberError tooManyPendingInvites(long value)

Returns an instance of AddFolderMemberError that has its tag set to AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES.

The value is the pending invite limit that was reached.

Parameters:

value - value to assign to this instance.

Returns:

Instance of AddFolderMemberError with its tag set to AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES.

getTooManyPendingInvitesValue

public long getTooManyPendingInvitesValue()

The value is the pending invite limit that was reached.

This instance must be tagged as AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES.

Returns:

The

invalid reference

long

value associated with this instance if isTooManyPendingInvites() is true.

Throws:

IllegalStateException - If isTooManyPendingInvites() is false.

isRateLimit

public boolean isRateLimit()

Returns true if this instance has the tag AddFolderMemberError.Tag.RATE_LIMIT, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.RATE_LIMIT, false otherwise.

isTooManyInvitees

public boolean isTooManyInvitees()

Returns true if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_INVITEES, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.TOO_MANY_INVITEES, false otherwise.

isInsufficientPlan

public boolean isInsufficientPlan()

Returns true if this instance has the tag AddFolderMemberError.Tag.INSUFFICIENT_PLAN, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.INSUFFICIENT_PLAN, false otherwise.

isTeamFolder

public boolean isTeamFolder()

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

Returns:

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

isNoPermission

public boolean isNoPermission()

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

Returns:

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

isInvalidSharedFolder

public boolean isInvalidSharedFolder()

Returns true if this instance has the tag AddFolderMemberError.Tag.INVALID_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as AddFolderMemberError.Tag.INVALID_SHARED_FOLDER, false otherwise.

isOther

public boolean isOther()

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

Returns:

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