Package com.dropbox.core.v2.sharing

Class FileMemberActionIndividualResult

java.lang.Object

com.dropbox.core.v2.sharing.FileMemberActionIndividualResult

public final class FileMemberActionIndividualResult
extends Object

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FileMemberActionIndividualResult.Tag	Discriminating tag type for FileMemberActionIndividualResult.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
FileMemberActionError	getMemberErrorValue()	User was not able to perform this action.
AccessLevel	getSuccessValue()	Part of the response for both add_file_member and remove_file_member_v1 (deprecated).
int	hashCode()
boolean	isMemberError()	Returns true if this instance has the tag FileMemberActionIndividualResult.Tag.MEMBER_ERROR, false otherwise.
boolean	isSuccess()	Returns true if this instance has the tag FileMemberActionIndividualResult.Tag.SUCCESS, false otherwise.
static FileMemberActionIndividualResult	memberError(FileMemberActionError value)	Returns an instance of FileMemberActionIndividualResult that has its tag set to FileMemberActionIndividualResult.Tag.MEMBER_ERROR.
static FileMemberActionIndividualResult	success()	Returns an instance of FileMemberActionIndividualResult that has its tag set to FileMemberActionIndividualResult.Tag.SUCCESS.
static FileMemberActionIndividualResult	success(AccessLevel value)	Returns an instance of FileMemberActionIndividualResult that has its tag set to FileMemberActionIndividualResult.Tag.SUCCESS.
FileMemberActionIndividualResult.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

tag

public FileMemberActionIndividualResult.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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this FileMemberActionIndividualResult.

Returns:

the tag for this instance.

isSuccess

public boolean isSuccess()

Returns true if this instance has the tag FileMemberActionIndividualResult.Tag.SUCCESS, false otherwise.

Returns:

true if this instance is tagged as FileMemberActionIndividualResult.Tag.SUCCESS, false otherwise.

success

public static FileMemberActionIndividualResult success(AccessLevel value)

Returns an instance of FileMemberActionIndividualResult that has its tag set to FileMemberActionIndividualResult.Tag.SUCCESS.

Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileMemberActionIndividualResult with its tag set to FileMemberActionIndividualResult.Tag.SUCCESS.

success

public static FileMemberActionIndividualResult success()

Returns an instance of FileMemberActionIndividualResult that has its tag set to FileMemberActionIndividualResult.Tag.SUCCESS.

Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.

Returns:

Instance of FileMemberActionIndividualResult with its tag set to FileMemberActionIndividualResult.Tag.SUCCESS.

getSuccessValue

public AccessLevel getSuccessValue()

Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.

This instance must be tagged as FileMemberActionIndividualResult.Tag.SUCCESS.

Returns:

The AccessLevel value associated with this instance if isSuccess() is true.

Throws:

IllegalStateException - If isSuccess() is false.

isMemberError

public boolean isMemberError()

Returns true if this instance has the tag FileMemberActionIndividualResult.Tag.MEMBER_ERROR, false otherwise.

Returns:

true if this instance is tagged as FileMemberActionIndividualResult.Tag.MEMBER_ERROR, false otherwise.

memberError

public static FileMemberActionIndividualResult memberError(FileMemberActionError value)

Returns an instance of FileMemberActionIndividualResult that has its tag set to FileMemberActionIndividualResult.Tag.MEMBER_ERROR.

User was not able to perform this action.

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileMemberActionIndividualResult with its tag set to FileMemberActionIndividualResult.Tag.MEMBER_ERROR.

Throws:

IllegalArgumentException - if value is null.

getMemberErrorValue

public FileMemberActionError getMemberErrorValue()

User was not able to perform this action.

This instance must be tagged as FileMemberActionIndividualResult.Tag.MEMBER_ERROR.

Returns:

The FileMemberActionError value associated with this instance if isMemberError() is true.

Throws:

IllegalStateException - If isMemberError() is false.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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