MemberAddResult (Official Dropbox Java SDK 2.1.2 API)

java.lang.Object
- com.dropbox.core.v2.team.MemberAddResult

```
public final class MemberAddResult
extends Object
```
Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed.
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 MemberAddResult.Tag
Discriminating tag type for MemberAddResult.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MemberAddResult.Tag` Discriminating tag type for `MemberAddResult`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MemberAddResult`	`duplicateExternalMemberId(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID`.
`boolean`	`equals(Object obj)`
`static MemberAddResult`	`freeTeamMemberLimitReached(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED`.
`String`	`getDuplicateExternalMemberIdValue()` A user with the given external member ID already exists on the team (including in recoverable state).
`String`	`getFreeTeamMemberLimitReachedValue()` Team is already full.
`TeamMemberInfo`	`getSuccessValue()` Describes a user that was successfully added to the team.
`String`	`getTeamLicenseLimitValue()` Team is already full.
`String`	`getUserAlreadyOnTeamValue()` User is already on this team.
`String`	`getUserAlreadyPairedValue()` User is already paired.
`String`	`getUserCreationFailedValue()` User creation has failed.
`String`	`getUserMigrationFailedValue()` User migration has failed.
`String`	`getUserOnAnotherTeamValue()` User is already on another team.
`int`	`hashCode()`
`boolean`	`isDuplicateExternalMemberId()` Returns `true` if this instance has the tag `MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID`, `false` otherwise.
`boolean`	`isFreeTeamMemberLimitReached()` Returns `true` if this instance has the tag `MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED`, `false` otherwise.
`boolean`	`isSuccess()` Returns `true` if this instance has the tag `MemberAddResult.Tag.SUCCESS`, `false` otherwise.
`boolean`	`isTeamLicenseLimit()` Returns `true` if this instance has the tag `MemberAddResult.Tag.TEAM_LICENSE_LIMIT`, `false` otherwise.
`boolean`	`isUserAlreadyOnTeam()` Returns `true` if this instance has the tag `MemberAddResult.Tag.USER_ALREADY_ON_TEAM`, `false` otherwise.
`boolean`	`isUserAlreadyPaired()` Returns `true` if this instance has the tag `MemberAddResult.Tag.USER_ALREADY_PAIRED`, `false` otherwise.
`boolean`	`isUserCreationFailed()` Returns `true` if this instance has the tag `MemberAddResult.Tag.USER_CREATION_FAILED`, `false` otherwise.
`boolean`	`isUserMigrationFailed()` Returns `true` if this instance has the tag `MemberAddResult.Tag.USER_MIGRATION_FAILED`, `false` otherwise.
`boolean`	`isUserOnAnotherTeam()` Returns `true` if this instance has the tag `MemberAddResult.Tag.USER_ON_ANOTHER_TEAM`, `false` otherwise.
`static MemberAddResult`	`success(TeamMemberInfo value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.SUCCESS`.
`MemberAddResult.Tag`	`tag()` Returns the tag for this instance.
`static MemberAddResult`	`teamLicenseLimit(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.TEAM_LICENSE_LIMIT`.
`String`	`toString()`
`String`	`toStringMultiline()` Returns a String representation of this object formatted for easier readability.
`static MemberAddResult`	`userAlreadyOnTeam(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.USER_ALREADY_ON_TEAM`.
`static MemberAddResult`	`userAlreadyPaired(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.USER_ALREADY_PAIRED`.
`static MemberAddResult`	`userCreationFailed(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.USER_CREATION_FAILED`.
`static MemberAddResult`	`userMigrationFailed(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.USER_MIGRATION_FAILED`.
`static MemberAddResult`	`userOnAnotherTeam(String value)` Returns an instance of `MemberAddResult` that has its tag set to `MemberAddResult.Tag.USER_ON_ANOTHER_TEAM`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - tag
```
public MemberAddResult.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 MemberAddResult.
    
    Returns:
    
    the tag for this instance.
  - isSuccess
```
public boolean isSuccess()
```
    Returns true if this instance has the tag MemberAddResult.Tag.SUCCESS, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.SUCCESS, false otherwise.
  - success
```
public static MemberAddResult success(TeamMemberInfo value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.SUCCESS.
    Describes a user that was successfully added to the team.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.SUCCESS.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - getSuccessValue
```
public TeamMemberInfo getSuccessValue()
```
    Describes a user that was successfully added to the team.
    This instance must be tagged as MemberAddResult.Tag.SUCCESS.
    
    Returns:
    
    The TeamMemberInfo value associated with this instance if isSuccess() is true.
    
    Throws:
    
    IllegalStateException - If isSuccess() is false.
  - isTeamLicenseLimit
```
public boolean isTeamLicenseLimit()
```
    Returns true if this instance has the tag MemberAddResult.Tag.TEAM_LICENSE_LIMIT, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.TEAM_LICENSE_LIMIT, false otherwise.
  - teamLicenseLimit
```
public static MemberAddResult teamLicenseLimit(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.TEAM_LICENSE_LIMIT.
    Team is already full. The organization has no available licenses.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.TEAM_LICENSE_LIMIT.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getTeamLicenseLimitValue
```
public String getTeamLicenseLimitValue()
```
    Team is already full. The organization has no available licenses.
    This instance must be tagged as MemberAddResult.Tag.TEAM_LICENSE_LIMIT.
    
    Returns:
    
    The String value associated with this instance if isTeamLicenseLimit() is true.
    
    Throws:
    
    IllegalStateException - If isTeamLicenseLimit() is false.
  - isFreeTeamMemberLimitReached
```
public boolean isFreeTeamMemberLimitReached()
```
    Returns true if this instance has the tag MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED, false otherwise.
  - freeTeamMemberLimitReached
```
public static MemberAddResult freeTeamMemberLimitReached(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED.
    Team is already full. The free team member limit has been reached.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getFreeTeamMemberLimitReachedValue
```
public String getFreeTeamMemberLimitReachedValue()
```
    Team is already full. The free team member limit has been reached.
    This instance must be tagged as MemberAddResult.Tag.FREE_TEAM_MEMBER_LIMIT_REACHED.
    
    Returns:
    
    The String value associated with this instance if isFreeTeamMemberLimitReached() is true.
    
    Throws:
    
    IllegalStateException - If isFreeTeamMemberLimitReached() is false.
  - isUserAlreadyOnTeam
```
public boolean isUserAlreadyOnTeam()
```
    Returns true if this instance has the tag MemberAddResult.Tag.USER_ALREADY_ON_TEAM, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.USER_ALREADY_ON_TEAM, false otherwise.
  - userAlreadyOnTeam
```
public static MemberAddResult userAlreadyOnTeam(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.USER_ALREADY_ON_TEAM.
    User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.USER_ALREADY_ON_TEAM.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getUserAlreadyOnTeamValue
```
public String getUserAlreadyOnTeamValue()
```
    User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.
    This instance must be tagged as MemberAddResult.Tag.USER_ALREADY_ON_TEAM.
    
    Returns:
    
    The String value associated with this instance if isUserAlreadyOnTeam() is true.
    
    Throws:
    
    IllegalStateException - If isUserAlreadyOnTeam() is false.
  - isUserOnAnotherTeam
```
public boolean isUserOnAnotherTeam()
```
    Returns true if this instance has the tag MemberAddResult.Tag.USER_ON_ANOTHER_TEAM, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.USER_ON_ANOTHER_TEAM, false otherwise.
  - userOnAnotherTeam
```
public static MemberAddResult userOnAnotherTeam(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.USER_ON_ANOTHER_TEAM.
    User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.USER_ON_ANOTHER_TEAM.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getUserOnAnotherTeamValue
```
public String getUserOnAnotherTeamValue()
```
    User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.
    This instance must be tagged as MemberAddResult.Tag.USER_ON_ANOTHER_TEAM.
    
    Returns:
    
    The String value associated with this instance if isUserOnAnotherTeam() is true.
    
    Throws:
    
    IllegalStateException - If isUserOnAnotherTeam() is false.
  - isUserAlreadyPaired
```
public boolean isUserAlreadyPaired()
```
    Returns true if this instance has the tag MemberAddResult.Tag.USER_ALREADY_PAIRED, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.USER_ALREADY_PAIRED, false otherwise.
  - userAlreadyPaired
```
public static MemberAddResult userAlreadyPaired(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.USER_ALREADY_PAIRED.
    User is already paired.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.USER_ALREADY_PAIRED.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getUserAlreadyPairedValue
```
public String getUserAlreadyPairedValue()
```
    User is already paired.
    This instance must be tagged as MemberAddResult.Tag.USER_ALREADY_PAIRED.
    
    Returns:
    
    The String value associated with this instance if isUserAlreadyPaired() is true.
    
    Throws:
    
    IllegalStateException - If isUserAlreadyPaired() is false.
  - isUserMigrationFailed
```
public boolean isUserMigrationFailed()
```
    Returns true if this instance has the tag MemberAddResult.Tag.USER_MIGRATION_FAILED, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.USER_MIGRATION_FAILED, false otherwise.
  - userMigrationFailed
```
public static MemberAddResult userMigrationFailed(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.USER_MIGRATION_FAILED.
    User migration has failed.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.USER_MIGRATION_FAILED.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getUserMigrationFailedValue
```
public String getUserMigrationFailedValue()
```
    User migration has failed.
    This instance must be tagged as MemberAddResult.Tag.USER_MIGRATION_FAILED.
    
    Returns:
    
    The String value associated with this instance if isUserMigrationFailed() is true.
    
    Throws:
    
    IllegalStateException - If isUserMigrationFailed() is false.
  - isDuplicateExternalMemberId
```
public boolean isDuplicateExternalMemberId()
```
    Returns true if this instance has the tag MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID, false otherwise.
  - duplicateExternalMemberId
```
public static MemberAddResult duplicateExternalMemberId(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID.
    A user with the given external member ID already exists on the team (including in recoverable state).
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getDuplicateExternalMemberIdValue
```
public String getDuplicateExternalMemberIdValue()
```
    A user with the given external member ID already exists on the team (including in recoverable state).
    This instance must be tagged as MemberAddResult.Tag.DUPLICATE_EXTERNAL_MEMBER_ID.
    
    Returns:
    
    The String value associated with this instance if isDuplicateExternalMemberId() is true.
    
    Throws:
    
    IllegalStateException - If isDuplicateExternalMemberId() is false.
  - isUserCreationFailed
```
public boolean isUserCreationFailed()
```
    Returns true if this instance has the tag MemberAddResult.Tag.USER_CREATION_FAILED, false otherwise.
    
    Returns:
    
    true if this instance is tagged as MemberAddResult.Tag.USER_CREATION_FAILED, false otherwise.
  - userCreationFailed
```
public static MemberAddResult userCreationFailed(String value)
```
    Returns an instance of MemberAddResult that has its tag set to MemberAddResult.Tag.USER_CREATION_FAILED.
    User creation has failed.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of MemberAddResult with its tag set to MemberAddResult.Tag.USER_CREATION_FAILED.
    
    Throws:
    
    IllegalArgumentException - if value is longer than 255, does not match pattern "^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$", or is null.
  - getUserCreationFailedValue
```
public String getUserCreationFailedValue()
```
    User creation has failed.
    This instance must be tagged as MemberAddResult.Tag.USER_CREATION_FAILED.
    
    Returns:
    
    The String value associated with this instance if isUserCreationFailed() is true.
    
    Throws:
    
    IllegalStateException - If isUserCreationFailed() 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

Class MemberAddResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

tag

isSuccess

success

getSuccessValue

isTeamLicenseLimit

teamLicenseLimit

getTeamLicenseLimitValue

isFreeTeamMemberLimitReached

freeTeamMemberLimitReached

getFreeTeamMemberLimitReachedValue

isUserAlreadyOnTeam

userAlreadyOnTeam

getUserAlreadyOnTeamValue

isUserOnAnotherTeam

userOnAnotherTeam

getUserOnAnotherTeamValue

isUserAlreadyPaired

userAlreadyPaired

getUserAlreadyPairedValue

isUserMigrationFailed

userMigrationFailed

getUserMigrationFailedValue

isDuplicateExternalMemberId

duplicateExternalMemberId

getDuplicateExternalMemberIdValue

isUserCreationFailed

userCreationFailed

getUserCreationFailedValue

hashCode

equals

toString

toStringMultiline