Class TransferFolderError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.TransferFolderError
-
public final class TransferFolderError extends java.lang.Object
This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()
methods will returntrue
. You can usetag()
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 class
TransferFolderError.Tag
Discriminating tag type forTransferFolderError
.
-
Field Summary
Fields Modifier and Type Field Description static TransferFolderError
INVALID_DROPBOX_ID
TransferFolderArg.getToDropboxId()
is invalid.static TransferFolderError
NEW_OWNER_EMAIL_UNVERIFIED
The new designated owner's email address is not verified.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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TransferFolderError
accessError(SharedFolderAccessError value)
Returns an instance ofTransferFolderError
that has its tag set toTransferFolderError.Tag.ACCESS_ERROR
.boolean
equals(java.lang.Object obj)
SharedFolderAccessError
getAccessErrorValue()
This instance must be tagged asTransferFolderError.Tag.ACCESS_ERROR
.int
hashCode()
boolean
isAccessError()
boolean
isInvalidDropboxId()
Returnstrue
if this instance has the tagTransferFolderError.Tag.INVALID_DROPBOX_ID
,false
otherwise.boolean
isNewOwnerEmailUnverified()
Returnstrue
if this instance has the tagTransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED
,false
otherwise.boolean
isNewOwnerNotAMember()
Returnstrue
if this instance has the tagTransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER
,false
otherwise.boolean
isNewOwnerUnmounted()
Returnstrue
if this instance has the tagTransferFolderError.Tag.NEW_OWNER_UNMOUNTED
,false
otherwise.boolean
isNoPermission()
boolean
isOther()
boolean
isTeamFolder()
TransferFolderError.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
INVALID_DROPBOX_ID
public static final TransferFolderError INVALID_DROPBOX_ID
TransferFolderArg.getToDropboxId()
is invalid.
-
NEW_OWNER_NOT_A_MEMBER
public static final TransferFolderError NEW_OWNER_NOT_A_MEMBER
The new designated owner is not currently a member of the shared folder.
-
NEW_OWNER_UNMOUNTED
public static final TransferFolderError NEW_OWNER_UNMOUNTED
The new designated owner has not added the folder to their Dropbox.
-
NEW_OWNER_EMAIL_UNVERIFIED
public static final TransferFolderError NEW_OWNER_EMAIL_UNVERIFIED
The new designated owner'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_FOLDER
public static final TransferFolderError TEAM_FOLDER
This action cannot be performed on a team shared folder.
-
NO_PERMISSION
public static final TransferFolderError NO_PERMISSION
The current user does not have permission to perform this action.
-
OTHER
public static final TransferFolderError 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 Detail
-
tag
public TransferFolderError.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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisTransferFolderError
.If a tag returned by the server is unrecognized by this SDK, the
TransferFolderError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isAccessError
public boolean isAccessError()
- Returns:
true
if this instance is tagged asTransferFolderError.Tag.ACCESS_ERROR
,false
otherwise.
-
accessError
public static TransferFolderError accessError(SharedFolderAccessError value)
Returns an instance ofTransferFolderError
that has its tag set toTransferFolderError.Tag.ACCESS_ERROR
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
TransferFolderError
with its tag set toTransferFolderError.Tag.ACCESS_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asTransferFolderError.Tag.ACCESS_ERROR
.- Returns:
- The
SharedFolderAccessError
value associated with this instance ifisAccessError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisAccessError()
isfalse
.
-
isInvalidDropboxId
public boolean isInvalidDropboxId()
Returnstrue
if this instance has the tagTransferFolderError.Tag.INVALID_DROPBOX_ID
,false
otherwise.- Returns:
true
if this instance is tagged asTransferFolderError.Tag.INVALID_DROPBOX_ID
,false
otherwise.
-
isNewOwnerNotAMember
public boolean isNewOwnerNotAMember()
Returnstrue
if this instance has the tagTransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER
,false
otherwise.- Returns:
true
if this instance is tagged asTransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER
,false
otherwise.
-
isNewOwnerUnmounted
public boolean isNewOwnerUnmounted()
Returnstrue
if this instance has the tagTransferFolderError.Tag.NEW_OWNER_UNMOUNTED
,false
otherwise.- Returns:
true
if this instance is tagged asTransferFolderError.Tag.NEW_OWNER_UNMOUNTED
,false
otherwise.
-
isNewOwnerEmailUnverified
public boolean isNewOwnerEmailUnverified()
Returnstrue
if this instance has the tagTransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED
,false
otherwise.- Returns:
true
if this instance is tagged asTransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED
,false
otherwise.
-
isTeamFolder
public boolean isTeamFolder()
- Returns:
true
if this instance is tagged asTransferFolderError.Tag.TEAM_FOLDER
,false
otherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
true
if this instance is tagged asTransferFolderError.Tag.NO_PERMISSION
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asTransferFolderError.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toStringMultiline
public java.lang.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
-
-