public final class AddFolderMemberError
extends java.lang.Object
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.
Modifier and Type | Class and Description |
---|---|
static class |
AddFolderMemberError.Tag
Discriminating tag type for
AddFolderMemberError . |
Modifier and Type | Field and Description |
---|---|
static AddFolderMemberError |
BANNED_MEMBER
The current user has been banned.
|
static AddFolderMemberError |
CANT_SHARE_OUTSIDE_TEAM
Your team policy does not allow sharing outside of the team.
|
static AddFolderMemberError |
EMAIL_UNVERIFIED
The current user's e-mail address is unverified.
|
static AddFolderMemberError |
INSUFFICIENT_PLAN
The current user's account doesn't support this action.
|
static AddFolderMemberError |
INVALID_SHARED_FOLDER
Invalid shared folder error will be returned as an access_error.
|
static AddFolderMemberError |
NO_PERMISSION
The current user does not have permission to perform this action.
|
static AddFolderMemberError |
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
|
static AddFolderMemberError |
RATE_LIMIT
The current user has hit the limit of invites they can send per day.
|
static AddFolderMemberError |
TEAM_FOLDER
This action cannot be performed on a team shared folder.
|
static AddFolderMemberError |
TOO_MANY_INVITEES
The current user is trying to share with too many people at once.
|
Modifier and Type | Method and 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(java.lang.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()
|
boolean |
isBadMember()
|
boolean |
isBannedMember()
|
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()
|
boolean |
isOther()
|
boolean |
isRateLimit()
|
boolean |
isTeamFolder()
|
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 . |
java.lang.String |
toString() |
java.lang.String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
public static final AddFolderMemberError EMAIL_UNVERIFIED
public static final AddFolderMemberError BANNED_MEMBER
public static final AddFolderMemberError CANT_SHARE_OUTSIDE_TEAM
public static final AddFolderMemberError RATE_LIMIT
public static final AddFolderMemberError TOO_MANY_INVITEES
public static final AddFolderMemberError INSUFFICIENT_PLAN
public static final AddFolderMemberError TEAM_FOLDER
public static final AddFolderMemberError NO_PERMISSION
public static final AddFolderMemberError INVALID_SHARED_FOLDER
public static final AddFolderMemberError OTHER
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.
public AddFolderMemberError.Tag tag()
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.
public boolean isAccessError()
true
if this instance is tagged as AddFolderMemberError.Tag.ACCESS_ERROR
, false
otherwise.public static AddFolderMemberError accessError(SharedFolderAccessError value)
AddFolderMemberError
that has its tag set
to AddFolderMemberError.Tag.ACCESS_ERROR
.
Unable to access shared folder.
value
- value to assign to this instance.AddFolderMemberError
with its tag set to
AddFolderMemberError.Tag.ACCESS_ERROR
.java.lang.IllegalArgumentException
- if value
is null
.public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged as AddFolderMemberError.Tag.ACCESS_ERROR
.
SharedFolderAccessError
value associated with this
instance if isAccessError()
is true
.java.lang.IllegalStateException
- If isAccessError()
is false
.public boolean isEmailUnverified()
true
if this instance has the tag AddFolderMemberError.Tag.EMAIL_UNVERIFIED
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.EMAIL_UNVERIFIED
, false
otherwise.public boolean isBannedMember()
true
if this instance is tagged as AddFolderMemberError.Tag.BANNED_MEMBER
, false
otherwise.public boolean isBadMember()
true
if this instance is tagged as AddFolderMemberError.Tag.BAD_MEMBER
, false
otherwise.public static AddFolderMemberError badMember(AddMemberSelectorError value)
AddFolderMemberError
that has its tag set
to AddFolderMemberError.Tag.BAD_MEMBER
.
AddFolderMemberArg.getMembers()
contains a bad invitation
recipient.
value
- value to assign to this instance.AddFolderMemberError
with its tag set to
AddFolderMemberError.Tag.BAD_MEMBER
.java.lang.IllegalArgumentException
- if value
is null
.public AddMemberSelectorError getBadMemberValue()
AddFolderMemberArg.getMembers()
contains a bad invitation
recipient.
This instance must be tagged as AddFolderMemberError.Tag.BAD_MEMBER
.
AddMemberSelectorError
value associated with this
instance if isBadMember()
is true
.java.lang.IllegalStateException
- If isBadMember()
is false
.public boolean isCantShareOutsideTeam()
true
if this instance has the tag AddFolderMemberError.Tag.CANT_SHARE_OUTSIDE_TEAM
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.CANT_SHARE_OUTSIDE_TEAM
, false
otherwise.public boolean isTooManyMembers()
true
if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_MEMBERS
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.TOO_MANY_MEMBERS
, false
otherwise.public static AddFolderMemberError tooManyMembers(long value)
AddFolderMemberError
that has its tag set
to AddFolderMemberError.Tag.TOO_MANY_MEMBERS
.
The value is the member limit that was reached.
value
- value to assign to this instance.AddFolderMemberError
with its tag set to
AddFolderMemberError.Tag.TOO_MANY_MEMBERS
.public long getTooManyMembersValue()
This instance must be tagged as AddFolderMemberError.Tag.TOO_MANY_MEMBERS
.
long
value associated with this instance if isTooManyMembers()
is true
.java.lang.IllegalStateException
- If isTooManyMembers()
is false
.public boolean isTooManyPendingInvites()
true
if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES
, false
otherwise.public static AddFolderMemberError tooManyPendingInvites(long value)
AddFolderMemberError
that has its tag set
to AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES
.
The value is the pending invite limit that was reached.
value
- value to assign to this instance.AddFolderMemberError
with its tag set to
AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES
.public long getTooManyPendingInvitesValue()
This instance must be tagged as AddFolderMemberError.Tag.TOO_MANY_PENDING_INVITES
.
long
value associated with this instance if isTooManyPendingInvites()
is true
.java.lang.IllegalStateException
- If isTooManyPendingInvites()
is
false
.public boolean isRateLimit()
true
if this instance is tagged as AddFolderMemberError.Tag.RATE_LIMIT
, false
otherwise.public boolean isTooManyInvitees()
true
if this instance has the tag AddFolderMemberError.Tag.TOO_MANY_INVITEES
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.TOO_MANY_INVITEES
, false
otherwise.public boolean isInsufficientPlan()
true
if this instance has the tag AddFolderMemberError.Tag.INSUFFICIENT_PLAN
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.INSUFFICIENT_PLAN
, false
otherwise.public boolean isTeamFolder()
true
if this instance is tagged as AddFolderMemberError.Tag.TEAM_FOLDER
, false
otherwise.public boolean isNoPermission()
true
if this instance is tagged as AddFolderMemberError.Tag.NO_PERMISSION
, false
otherwise.public boolean isInvalidSharedFolder()
true
if this instance has the tag AddFolderMemberError.Tag.INVALID_SHARED_FOLDER
, false
otherwise.true
if this instance is tagged as AddFolderMemberError.Tag.INVALID_SHARED_FOLDER
, false
otherwise.public boolean isOther()
true
if this instance is tagged as AddFolderMemberError.Tag.OTHER
,
false
otherwise.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringMultiline()
The returned String may contain newlines.