Package com.dropbox.core.v2.teamlog

Class ActionDetails

java.lang.Object

com.dropbox.core.v2.teamlog.ActionDetails

public final class ActionDetails
extends java.lang.Object

Additional information indicating the action taken that caused status change.

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 return true. You can use tag() 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	ActionDetails.Tag	Discriminating tag type for ActionDetails.

Field Summary

Fields

Modifier and Type	Field	Description
static ActionDetails	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
MemberRemoveActionType	getRemoveActionValue()	Define how the user was removed from the team.
TeamInviteDetails	getTeamInviteDetailsValue()	Additional information relevant when someone is invited to the team.
JoinTeamDetails	getTeamJoinDetailsValue()	Additional information relevant when a new member joins the team.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag ActionDetails.Tag.OTHER, false otherwise.
boolean	isRemoveAction()	Returns true if this instance has the tag ActionDetails.Tag.REMOVE_ACTION, false otherwise.
boolean	isTeamInviteDetails()	Returns true if this instance has the tag ActionDetails.Tag.TEAM_INVITE_DETAILS, false otherwise.
boolean	isTeamJoinDetails()	Returns true if this instance has the tag ActionDetails.Tag.TEAM_JOIN_DETAILS, false otherwise.
static ActionDetails	removeAction(MemberRemoveActionType value)	Returns an instance of ActionDetails that has its tag set to ActionDetails.Tag.REMOVE_ACTION.
ActionDetails.Tag	tag()	Returns the tag for this instance.
static ActionDetails	teamInviteDetails(TeamInviteDetails value)	Returns an instance of ActionDetails that has its tag set to ActionDetails.Tag.TEAM_INVITE_DETAILS.
static ActionDetails	teamJoinDetails(JoinTeamDetails value)	Returns an instance of ActionDetails that has its tag set to ActionDetails.Tag.TEAM_JOIN_DETAILS.
java.lang.String	toString()
java.lang.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

Field Detail

OTHER

public static final ActionDetails 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 ActionDetails.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 ActionDetails.

If a tag returned by the server is unrecognized by this SDK, the ActionDetails.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isTeamJoinDetails

public boolean isTeamJoinDetails()

Returns true if this instance has the tag ActionDetails.Tag.TEAM_JOIN_DETAILS, false otherwise.

Returns:

true if this instance is tagged as ActionDetails.Tag.TEAM_JOIN_DETAILS, false otherwise.

teamJoinDetails

public static ActionDetails teamJoinDetails(JoinTeamDetails value)

Returns an instance of ActionDetails that has its tag set to ActionDetails.Tag.TEAM_JOIN_DETAILS.

Additional information relevant when a new member joins the team.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActionDetails with its tag set to ActionDetails.Tag.TEAM_JOIN_DETAILS.

Throws:

java.lang.IllegalArgumentException - if value is null.

getTeamJoinDetailsValue

public JoinTeamDetails getTeamJoinDetailsValue()

Additional information relevant when a new member joins the team.

This instance must be tagged as ActionDetails.Tag.TEAM_JOIN_DETAILS.

Returns:

The JoinTeamDetails value associated with this instance if isTeamJoinDetails() is true.

Throws:

java.lang.IllegalStateException - If isTeamJoinDetails() is false.

isRemoveAction

public boolean isRemoveAction()

Returns true if this instance has the tag ActionDetails.Tag.REMOVE_ACTION, false otherwise.

Returns:

true if this instance is tagged as ActionDetails.Tag.REMOVE_ACTION, false otherwise.

removeAction

public static ActionDetails removeAction(MemberRemoveActionType value)

Returns an instance of ActionDetails that has its tag set to ActionDetails.Tag.REMOVE_ACTION.

Define how the user was removed from the team.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActionDetails with its tag set to ActionDetails.Tag.REMOVE_ACTION.

Throws:

java.lang.IllegalArgumentException - if value is null.

getRemoveActionValue

public MemberRemoveActionType getRemoveActionValue()

Define how the user was removed from the team.

This instance must be tagged as ActionDetails.Tag.REMOVE_ACTION.

Returns:

The MemberRemoveActionType value associated with this instance if isRemoveAction() is true.

Throws:

java.lang.IllegalStateException - If isRemoveAction() is false.

isTeamInviteDetails

public boolean isTeamInviteDetails()

Returns true if this instance has the tag ActionDetails.Tag.TEAM_INVITE_DETAILS, false otherwise.

Returns:

true if this instance is tagged as ActionDetails.Tag.TEAM_INVITE_DETAILS, false otherwise.

teamInviteDetails

public static ActionDetails teamInviteDetails(TeamInviteDetails value)

Returns an instance of ActionDetails that has its tag set to ActionDetails.Tag.TEAM_INVITE_DETAILS.

Additional information relevant when someone is invited to the team.

Parameters:

value - value to assign to this instance.

Returns:

Instance of ActionDetails with its tag set to ActionDetails.Tag.TEAM_INVITE_DETAILS.

Throws:

java.lang.IllegalArgumentException - if value is null.

getTeamInviteDetailsValue

public TeamInviteDetails getTeamInviteDetailsValue()

Additional information relevant when someone is invited to the team.

This instance must be tagged as ActionDetails.Tag.TEAM_INVITE_DETAILS.

Returns:

The TeamInviteDetails value associated with this instance if isTeamInviteDetails() is true.

Throws:

java.lang.IllegalStateException - If isTeamInviteDetails() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag ActionDetails.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as ActionDetails.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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