com.dropbox.core.v2.team

Class TeamMemberStatus

java.lang.Object

com.dropbox.core.v2.team.TeamMemberStatus

public final class TeamMemberStatus
extends java.lang.Object

The user's status as a member of a specific team.

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 and Description
static class	TeamMemberStatus.Tag Discriminating tag type for TeamMemberStatus.

Field Summary

Fields

Modifier and Type	Field and Description
static TeamMemberStatus	ACTIVE User has successfully joined the team.
static TeamMemberStatus	INVITED User has been invited to a team, but has not joined the team yet.
static TeamMemberStatus	SUSPENDED User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
RemovedStatus	getRemovedValue() User is no longer a member of the team.
int	hashCode()
boolean	isActive() Returns true if this instance has the tag TeamMemberStatus.Tag.ACTIVE, false otherwise.
boolean	isInvited() Returns true if this instance has the tag TeamMemberStatus.Tag.INVITED, false otherwise.
boolean	isRemoved() Returns true if this instance has the tag TeamMemberStatus.Tag.REMOVED, false otherwise.
boolean	isSuspended() Returns true if this instance has the tag TeamMemberStatus.Tag.SUSPENDED, false otherwise.
static TeamMemberStatus	removed(RemovedStatus value) Returns an instance of TeamMemberStatus that has its tag set to TeamMemberStatus.Tag.REMOVED.
TeamMemberStatus.Tag	tag() Returns the tag for this instance.
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

ACTIVE

public static final TeamMemberStatus ACTIVE

User has successfully joined the team.

INVITED

public static final TeamMemberStatus INVITED

User has been invited to a team, but has not joined the team yet.

SUSPENDED

public static final TeamMemberStatus SUSPENDED

User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.

Method Detail

tag

public TeamMemberStatus.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 TeamMemberStatus.

Returns:

the tag for this instance.

isActive

public boolean isActive()

Returns true if this instance has the tag TeamMemberStatus.Tag.ACTIVE, false otherwise.

Returns:

true if this instance is tagged as TeamMemberStatus.Tag.ACTIVE, false otherwise.

isInvited

public boolean isInvited()

Returns true if this instance has the tag TeamMemberStatus.Tag.INVITED, false otherwise.

Returns:

true if this instance is tagged as TeamMemberStatus.Tag.INVITED, false otherwise.

isSuspended

public boolean isSuspended()

Returns true if this instance has the tag TeamMemberStatus.Tag.SUSPENDED, false otherwise.

Returns:

true if this instance is tagged as TeamMemberStatus.Tag.SUSPENDED, false otherwise.

isRemoved

public boolean isRemoved()

Returns true if this instance has the tag TeamMemberStatus.Tag.REMOVED, false otherwise.

Returns:

true if this instance is tagged as TeamMemberStatus.Tag.REMOVED, false otherwise.

removed

public static TeamMemberStatus removed(RemovedStatus value)

Returns an instance of TeamMemberStatus that has its tag set to TeamMemberStatus.Tag.REMOVED.

User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.

Parameters:

value - value to assign to this instance.

Returns:

Instance of TeamMemberStatus with its tag set to TeamMemberStatus.Tag.REMOVED.

Throws:

java.lang.IllegalArgumentException - if value is null.

getRemovedValue

public RemovedStatus getRemovedValue()

User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.

This instance must be tagged as TeamMemberStatus.Tag.REMOVED.

Returns:

The RemovedStatus value associated with this instance if isRemoved() is true.

Throws:

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

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