Class TransferFolderError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.TransferFolderError
-
public final class TransferFolderError extends java.lang.ObjectThis 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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransferFolderError.TagDiscriminating tag type forTransferFolderError.
-
Field Summary
Fields Modifier and Type Field Description static TransferFolderErrorINVALID_DROPBOX_IDTransferFolderArg.getToDropboxId()is invalid.static TransferFolderErrorNEW_OWNER_EMAIL_UNVERIFIEDThe new designated owner's email address is not verified.static TransferFolderErrorNEW_OWNER_NOT_A_MEMBERThe new designated owner is not currently a member of the shared folder.static TransferFolderErrorNEW_OWNER_UNMOUNTEDThe new designated owner has not added the folder to their Dropbox.static TransferFolderErrorNO_PERMISSIONThe current user does not have permission to perform this action.static TransferFolderErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static TransferFolderErrorTEAM_FOLDERThis 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 TransferFolderErroraccessError(SharedFolderAccessError value)Returns an instance ofTransferFolderErrorthat has its tag set toTransferFolderError.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharedFolderAccessErrorgetAccessErrorValue()This instance must be tagged asTransferFolderError.Tag.ACCESS_ERROR.inthashCode()booleanisAccessError()booleanisInvalidDropboxId()Returnstrueif this instance has the tagTransferFolderError.Tag.INVALID_DROPBOX_ID,falseotherwise.booleanisNewOwnerEmailUnverified()Returnstrueif this instance has the tagTransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED,falseotherwise.booleanisNewOwnerNotAMember()Returnstrueif this instance has the tagTransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER,falseotherwise.booleanisNewOwnerUnmounted()Returnstrueif this instance has the tagTransferFolderError.Tag.NEW_OWNER_UNMOUNTED,falseotherwise.booleanisNoPermission()booleanisOther()booleanisTeamFolder()TransferFolderError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()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 aswitchstatement to properly handle the different values for thisTransferFolderError.If a tag returned by the server is unrecognized by this SDK, the
TransferFolderError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isAccessError
public boolean isAccessError()
- Returns:
trueif this instance is tagged asTransferFolderError.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static TransferFolderError accessError(SharedFolderAccessError value)
Returns an instance ofTransferFolderErrorthat has its tag set toTransferFolderError.Tag.ACCESS_ERROR.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
TransferFolderErrorwith its tag set toTransferFolderError.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAccessErrorValue
public SharedFolderAccessError getAccessErrorValue()
This instance must be tagged asTransferFolderError.Tag.ACCESS_ERROR.- Returns:
- The
SharedFolderAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isInvalidDropboxId
public boolean isInvalidDropboxId()
Returnstrueif this instance has the tagTransferFolderError.Tag.INVALID_DROPBOX_ID,falseotherwise.- Returns:
trueif this instance is tagged asTransferFolderError.Tag.INVALID_DROPBOX_ID,falseotherwise.
-
isNewOwnerNotAMember
public boolean isNewOwnerNotAMember()
Returnstrueif this instance has the tagTransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER,falseotherwise.- Returns:
trueif this instance is tagged asTransferFolderError.Tag.NEW_OWNER_NOT_A_MEMBER,falseotherwise.
-
isNewOwnerUnmounted
public boolean isNewOwnerUnmounted()
Returnstrueif this instance has the tagTransferFolderError.Tag.NEW_OWNER_UNMOUNTED,falseotherwise.- Returns:
trueif this instance is tagged asTransferFolderError.Tag.NEW_OWNER_UNMOUNTED,falseotherwise.
-
isNewOwnerEmailUnverified
public boolean isNewOwnerEmailUnverified()
Returnstrueif this instance has the tagTransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED,falseotherwise.- Returns:
trueif this instance is tagged asTransferFolderError.Tag.NEW_OWNER_EMAIL_UNVERIFIED,falseotherwise.
-
isTeamFolder
public boolean isTeamFolder()
- Returns:
trueif this instance is tagged asTransferFolderError.Tag.TEAM_FOLDER,falseotherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
trueif this instance is tagged asTransferFolderError.Tag.NO_PERMISSION,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asTransferFolderError.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-