Class AddFileMemberError
- java.lang.Object
-
- com.dropbox.core.v2.sharing.AddFileMemberError
-
public final class AddFileMemberError extends java.lang.ObjectErrors forDbxUserSharingRequests.addFileMember(String,java.util.List).This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the
isAbc()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 classAddFileMemberError.TagDiscriminating tag type forAddFileMemberError.
-
Field Summary
Fields Modifier and Type Field Description static AddFileMemberErrorINVALID_COMMENTThe custom message did not pass comment permissions checks.static AddFileMemberErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static AddFileMemberErrorRATE_LIMITThe user has reached the rate limit for invitations.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AddFileMemberErroraccessError(SharingFileAccessError value)Returns an instance ofAddFileMemberErrorthat has its tag set toAddFileMemberError.Tag.ACCESS_ERROR.booleanequals(java.lang.Object obj)SharingFileAccessErrorgetAccessErrorValue()This instance must be tagged asAddFileMemberError.Tag.ACCESS_ERROR.SharingUserErrorgetUserErrorValue()This instance must be tagged asAddFileMemberError.Tag.USER_ERROR.inthashCode()booleanisAccessError()booleanisInvalidComment()booleanisOther()booleanisRateLimit()booleanisUserError()AddFileMemberError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.static AddFileMemberErroruserError(SharingUserError value)Returns an instance ofAddFileMemberErrorthat has its tag set toAddFileMemberError.Tag.USER_ERROR.
-
-
-
Field Detail
-
RATE_LIMIT
public static final AddFileMemberError RATE_LIMIT
The user has reached the rate limit for invitations.
-
INVALID_COMMENT
public static final AddFileMemberError INVALID_COMMENT
The custom message did not pass comment permissions checks.
-
OTHER
public static final AddFileMemberError 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 AddFileMemberError.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 thisAddFileMemberError.If a tag returned by the server is unrecognized by this SDK, the
AddFileMemberError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isUserError
public boolean isUserError()
- Returns:
trueif this instance is tagged asAddFileMemberError.Tag.USER_ERROR,falseotherwise.
-
userError
public static AddFileMemberError userError(SharingUserError value)
Returns an instance ofAddFileMemberErrorthat has its tag set toAddFileMemberError.Tag.USER_ERROR.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
AddFileMemberErrorwith its tag set toAddFileMemberError.Tag.USER_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getUserErrorValue
public SharingUserError getUserErrorValue()
This instance must be tagged asAddFileMemberError.Tag.USER_ERROR.- Returns:
- The
SharingUserErrorvalue associated with this instance ifisUserError()istrue. - Throws:
java.lang.IllegalStateException- IfisUserError()isfalse.
-
isAccessError
public boolean isAccessError()
- Returns:
trueif this instance is tagged asAddFileMemberError.Tag.ACCESS_ERROR,falseotherwise.
-
accessError
public static AddFileMemberError accessError(SharingFileAccessError value)
Returns an instance ofAddFileMemberErrorthat has its tag set toAddFileMemberError.Tag.ACCESS_ERROR.None
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
AddFileMemberErrorwith its tag set toAddFileMemberError.Tag.ACCESS_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getAccessErrorValue
public SharingFileAccessError getAccessErrorValue()
This instance must be tagged asAddFileMemberError.Tag.ACCESS_ERROR.- Returns:
- The
SharingFileAccessErrorvalue associated with this instance ifisAccessError()istrue. - Throws:
java.lang.IllegalStateException- IfisAccessError()isfalse.
-
isRateLimit
public boolean isRateLimit()
- Returns:
trueif this instance is tagged asAddFileMemberError.Tag.RATE_LIMIT,falseotherwise.
-
isInvalidComment
public boolean isInvalidComment()
- Returns:
trueif this instance is tagged asAddFileMemberError.Tag.INVALID_COMMENT,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asAddFileMemberError.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
-
-