public final class TransferFolderError extends 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 |
TransferFolderError.Tag
Discriminating tag type for
TransferFolderError . |
Modifier and Type | Field and Description |
---|---|
static TransferFolderError |
INVALID_DROPBOX_ID
TransferFolderArg.getToDropboxId() is invalid. |
static TransferFolderError |
NEW_OWNER_EMAIL_UNVERIFIED
The new designated owner's e-mail address is unverified.
|
static TransferFolderError |
NEW_OWNER_NOT_A_MEMBER
The new designated owner is not currently a member of the shared folder.
|
static TransferFolderError |
NEW_OWNER_UNMOUNTED
The new designated owner has not added the folder to their Dropbox.
|
static TransferFolderError |
NO_PERMISSION
The current user does not have permission to perform this action.
|
static TransferFolderError |
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
|
static TransferFolderError |
TEAM_FOLDER
This action cannot be performed on a team shared folder.
|
Modifier and Type | Method and Description |
---|---|
static TransferFolderError |
accessError(SharedFolderAccessError value)
Returns an instance of
TransferFolderError that has its tag set
to TransferFolderError.Tag.ACCESS_ERROR . |
boolean |
equals(Object obj) |
SharedFolderAccessError |
getAccessErrorValue()
This instance must be tagged as
TransferFolderError.Tag.ACCESS_ERROR . |
int |
hashCode() |
boolean |
isAccessError()
|
boolean |
isInvalidDropboxId()
Returns
true if this instance has the tag TransferFolderError.Tag.INVALID_DROPBOX_ID , false otherwise. |
boolean |
isNewOwnerEmailUnverified()
Returns
true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED , false otherwise. |
boolean |
isNewOwnerNotAMember()
Returns
true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER , false otherwise. |
boolean |
isNewOwnerUnmounted()
Returns
true if this instance has the tag TransferFolderError.Tag.NEW_OWNER_UNMOUNTED , false otherwise. |
boolean |
isNoPermission()
|
boolean |
isOther()
|
boolean |
isTeamFolder()
|
TransferFolderError.Tag |
tag()
Returns the tag for this instance.
|
String |
toString() |
String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
public static final TransferFolderError INVALID_DROPBOX_ID
TransferFolderArg.getToDropboxId()
is invalid.public static final TransferFolderError NEW_OWNER_NOT_A_MEMBER
public static final TransferFolderError NEW_OWNER_UNMOUNTED
public static final TransferFolderError NEW_OWNER_EMAIL_UNVERIFIED
public static final TransferFolderError TEAM_FOLDER
public static final TransferFolderError NO_PERMISSION
public static final TransferFolderError 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 TransferFolderError.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 TransferFolderError
.
If a tag returned by the server is unrecognized by this SDK, the
TransferFolderError.Tag.OTHER
value will be used.
public boolean isAccessError()
true
if this instance is tagged as TransferFolderError.Tag.ACCESS_ERROR
, false
otherwise.public static TransferFolderError accessError(SharedFolderAccessError value)
TransferFolderError
that has its tag set
to TransferFolderError.Tag.ACCESS_ERROR
.
None
value
- value to assign to this instance.TransferFolderError
with its tag set to
TransferFolderError.Tag.ACCESS_ERROR
.IllegalArgumentException
- if value
is null
.public SharedFolderAccessError getAccessErrorValue()
TransferFolderError.Tag.ACCESS_ERROR
.SharedFolderAccessError
value associated with this
instance if isAccessError()
is true
.IllegalStateException
- If isAccessError()
is false
.public boolean isInvalidDropboxId()
true
if this instance has the tag TransferFolderError.Tag.INVALID_DROPBOX_ID
, false
otherwise.true
if this instance is tagged as TransferFolderError.Tag.INVALID_DROPBOX_ID
, false
otherwise.public boolean isNewOwnerNotAMember()
true
if this instance has the tag TransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER
, false
otherwise.true
if this instance is tagged as TransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER
, false
otherwise.public boolean isNewOwnerUnmounted()
true
if this instance has the tag TransferFolderError.Tag.NEW_OWNER_UNMOUNTED
, false
otherwise.true
if this instance is tagged as TransferFolderError.Tag.NEW_OWNER_UNMOUNTED
, false
otherwise.public boolean isNewOwnerEmailUnverified()
true
if this instance has the tag TransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED
, false
otherwise.true
if this instance is tagged as TransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED
, false
otherwise.public boolean isTeamFolder()
true
if this instance is tagged as TransferFolderError.Tag.TEAM_FOLDER
, false
otherwise.public boolean isNoPermission()
true
if this instance is tagged as TransferFolderError.Tag.NO_PERMISSION
, false
otherwise.public boolean isOther()
true
if this instance is tagged as TransferFolderError.Tag.OTHER
,
false
otherwise.public String toStringMultiline()
The returned String may contain newlines.