Class FileMemberActionError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.FileMemberActionError
-
public final class FileMemberActionError 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 classFileMemberActionError.TagDiscriminating tag type forFileMemberActionError.
-
Field Summary
Fields Modifier and Type Field Description static FileMemberActionErrorINVALID_MEMBERSpecified member was not found.static FileMemberActionErrorNO_PERMISSIONUser does not have permission to perform this action on this member.static FileMemberActionErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FileMemberActionErroraccessError(SharingFileAccessError value)Returns an instance ofFileMemberActionErrorthat has its tag set toFileMemberActionError.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharingFileAccessErrorgetAccessErrorValue()Specified file was invalid or user does not have access.MemberAccessLevelResultgetNoExplicitAccessValue()The action cannot be completed because the target member does not have explicit access to the file.inthashCode()booleanisAccessError()booleanisInvalidMember()Returnstrueif this instance has the tagFileMemberActionError.Tag.INVALID_MEMBER,falseotherwise.booleanisNoExplicitAccess()Returnstrueif this instance has the tagFileMemberActionError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.booleanisNoPermission()booleanisOther()static FileMemberActionErrornoExplicitAccess(MemberAccessLevelResult value)Returns an instance ofFileMemberActionErrorthat has its tag set toFileMemberActionError.Tag.NO_EXPLICIT_ACCESS.FileMemberActionError.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_MEMBER
public static final FileMemberActionError INVALID_MEMBER
Specified member was not found.
-
NO_PERMISSION
public static final FileMemberActionError NO_PERMISSION
User does not have permission to perform this action on this member.
-
OTHER
public static final FileMemberActionError 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 FileMemberActionError.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 thisFileMemberActionError.If a tag returned by the server is unrecognized by this SDK, the
FileMemberActionError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isInvalidMember
public boolean isInvalidMember()
Returnstrueif this instance has the tagFileMemberActionError.Tag.INVALID_MEMBER,falseotherwise.- Returns:
trueif this instance is tagged asFileMemberActionError.Tag.INVALID_MEMBER,falseotherwise.
-
isNoPermission
public boolean isNoPermission()
- Returns:
trueif this instance is tagged asFileMemberActionError.Tag.NO_PERMISSION,falseotherwise.
-
isAccessError
public boolean isAccessError()
- Returns:
trueif this instance is tagged asFileMemberActionError.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static FileMemberActionError accessError(SharingFileAccessError value)
Returns an instance ofFileMemberActionErrorthat has its tag set toFileMemberActionError.Tag.ACCESS_ERROR.Specified file was invalid or user does not have access.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
FileMemberActionErrorwith its tag set toFileMemberActionError.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAccessErrorValue
public SharingFileAccessError getAccessErrorValue()
Specified file was invalid or user does not have access.This instance must be tagged as
FileMemberActionError.Tag.ACCESS_ERROR.- Returns:
- The
SharingFileAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isNoExplicitAccess
public boolean isNoExplicitAccess()
Returnstrueif this instance has the tagFileMemberActionError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.- Returns:
trueif this instance is tagged asFileMemberActionError.Tag.NO_EXPLICIT_ACCESS,falseotherwise.
-
noExplicitAccess
public static FileMemberActionError noExplicitAccess(MemberAccessLevelResult value)
Returns an instance ofFileMemberActionErrorthat has its tag set toFileMemberActionError.Tag.NO_EXPLICIT_ACCESS.The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
FileMemberActionErrorwith its tag set toFileMemberActionError.Tag.NO_EXPLICIT_ACCESS. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getNoExplicitAccessValue
public MemberAccessLevelResult getNoExplicitAccessValue()
The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.This instance must be tagged as
FileMemberActionError.Tag.NO_EXPLICIT_ACCESS.- Returns:
- The
MemberAccessLevelResultvalue associated with this instance ifisNoExplicitAccess()istrue. - Throws:
java.lang.IllegalStateException- IfisNoExplicitAccess()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asFileMemberActionError.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
-
-