Package com.dropbox.core.v2.users

Class BasicAccount

java.lang.Object

com.dropbox.core.v2.users.Account

com.dropbox.core.v2.users.BasicAccount

public class BasicAccount
extends Account

Basic information about any account.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicAccount.Builder	Builder for BasicAccount.
static class	BasicAccount.Serializer	For internal use only.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isTeammate
protected java.lang.String	teamMemberId

Fields inherited from class com.dropbox.core.v2.users.Account

accountId, disabled, email, emailVerified, name, profilePhotoUrl

Constructor Summary

Constructors

Constructor	Description
BasicAccount(java.lang.String accountId, Name name, java.lang.String email, boolean emailVerified, boolean disabled, boolean isTeammate)	Basic information about any account.
BasicAccount(java.lang.String accountId, Name name, java.lang.String email, boolean emailVerified, boolean disabled, boolean isTeammate, java.lang.String profilePhotoUrl, java.lang.String teamMemberId)	Basic information about any account.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccountId()	The user's unique Dropbox ID.
boolean	getDisabled()	Whether the user has been disabled.
java.lang.String	getEmail()	The user's email address.
boolean	getEmailVerified()	Whether the user has verified their email address.
boolean	getIsTeammate()	Whether this user is a teammate of the current user.
Name	getName()	Details of a user's name.
java.lang.String	getProfilePhotoUrl()	URL for the photo representing the user, if one is set.
java.lang.String	getTeamMemberId()	The user's unique team member id.
int	hashCode()
static BasicAccount.Builder	newBuilder(java.lang.String accountId, Name name, java.lang.String email, boolean emailVerified, boolean disabled, boolean isTeammate)	Returns a new builder for creating an instance of this class.
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

isTeammate

protected final boolean isTeammate

teamMemberId

@Nullable
protected final java.lang.String teamMemberId

Constructor Detail

BasicAccount

public BasicAccount(@Nonnull
                    java.lang.String accountId,
                    @Nonnull
                    Name name,
                    @Nonnull
                    java.lang.String email,
                    boolean emailVerified,
                    boolean disabled,
                    boolean isTeammate,
                    @Nullable
                    java.lang.String profilePhotoUrl,
                    @Nullable
                    java.lang.String teamMemberId)

Basic information about any account.

Use newBuilder(java.lang.String,com.dropbox.core.v2.users.Name,java.lang.String,boolean,boolean,boolean) to create instances of this class without specifying values for all optional fields.

Parameters:

accountId - The user's unique Dropbox ID. Must have length of at least 40, have length of at most 40, and not be null.

name - Details of a user's name. Must not be null.

email - The user's email address. Do not rely on this without checking the Account.getEmailVerified() field. Even then, it's possible that the user has since lost access to their email. Must not be null.

emailVerified - Whether the user has verified their email address.

disabled - Whether the user has been disabled.

isTeammate - Whether this user is a teammate of the current user. If this account is the current user's account, then this will be true.

profilePhotoUrl - URL for the photo representing the user, if one is set.

teamMemberId - The user's unique team member id. This field will only be present if the user is part of a team and getIsTeammate() is true.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

BasicAccount

public BasicAccount(@Nonnull
                    java.lang.String accountId,
                    @Nonnull
                    Name name,
                    @Nonnull
                    java.lang.String email,
                    boolean emailVerified,
                    boolean disabled,
                    boolean isTeammate)

Basic information about any account.

The default values for unset fields will be used.

Parameters:

accountId - The user's unique Dropbox ID. Must have length of at least 40, have length of at most 40, and not be null.

name - Details of a user's name. Must not be null.

email - The user's email address. Do not rely on this without checking the Account.getEmailVerified() field. Even then, it's possible that the user has since lost access to their email. Must not be null.

emailVerified - Whether the user has verified their email address.

disabled - Whether the user has been disabled.

isTeammate - Whether this user is a teammate of the current user. If this account is the current user's account, then this will be true.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getAccountId

@Nonnull
public java.lang.String getAccountId()

The user's unique Dropbox ID.

Overrides:

getAccountId in class Account

Returns:

value for this field, never null.

getName

@Nonnull
public Name getName()

Details of a user's name.

Overrides:

getName in class Account

Returns:

value for this field, never null.

getEmail

@Nonnull
public java.lang.String getEmail()

The user's email address. Do not rely on this without checking the Account.getEmailVerified() field. Even then, it's possible that the user has since lost access to their email.

Overrides:

getEmail in class Account

Returns:

value for this field, never null.

getEmailVerified

public boolean getEmailVerified()

Whether the user has verified their email address.

Overrides:

getEmailVerified in class Account

Returns:

value for this field.

getDisabled

public boolean getDisabled()

Whether the user has been disabled.

Overrides:

getDisabled in class Account

Returns:

value for this field.

getIsTeammate

public boolean getIsTeammate()

Whether this user is a teammate of the current user. If this account is the current user's account, then this will be true.

Returns:

value for this field.

getProfilePhotoUrl

@Nullable
public java.lang.String getProfilePhotoUrl()

URL for the photo representing the user, if one is set.

Overrides:

getProfilePhotoUrl in class Account

Returns:

value for this field, or null if not present.

getTeamMemberId

@Nullable
public java.lang.String getTeamMemberId()

The user's unique team member id. This field will only be present if the user is part of a team and getIsTeammate() is true.

Returns:

value for this field, or null if not present.

newBuilder

public static BasicAccount.Builder newBuilder(java.lang.String accountId,
                                              Name name,
                                              java.lang.String email,
                                              boolean emailVerified,
                                              boolean disabled,
                                              boolean isTeammate)

Returns a new builder for creating an instance of this class.

Parameters:

accountId - The user's unique Dropbox ID. Must have length of at least 40, have length of at most 40, and not be null.

name - Details of a user's name. Must not be null.

email - The user's email address. Do not rely on this without checking the Account.getEmailVerified() field. Even then, it's possible that the user has since lost access to their email. Must not be null.

emailVerified - Whether the user has verified their email address.

disabled - Whether the user has been disabled.

isTeammate - Whether this user is a teammate of the current user. If this account is the current user's account, then this will be true.

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class Account

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Account

toString

public java.lang.String toString()

Overrides:

toString in class Account

toStringMultiline

public java.lang.String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Overrides:

toStringMultiline in class Account

Returns:

Formatted, multiline String representation of this object