Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,22 @@ public class UserInfoResult {
* Use {@link newBuilder} to create instances of this class without
* specifying values for all optional fields.
*
* @param familyName Last name of user.
* @param givenName First name of user.
* @param email Email address of user.
* @param emailVerified If user is email verified.
* @param iss Issuer of token (in this case Dropbox). Must not be {@code
* null}.
* @param familyName Last name of the user.
* @param givenName First name of the user.
* @param email The user's email address. Be aware it's possible that the
* user has since lost access to their email. Note: email is not a
* unique or stable identifier for a Dropbox account. Users can change
* their email, and emails can be reused by different accounts. Apps
* should not use email as a key for account identification; use {@link
* UserInfoResult#getSub} instead.
* @param emailVerified If the user's email address is verified.
* @param iss Issuer of the token (in this case Dropbox). Must not be
* {@code null}.
* @param sub An identifier for the user. This is the Dropbox account_id, a
* string value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc. Must
* not be {@code null}.
* string value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc. The
* account_id is a unique and stable identifier for a Dropbox account,
* suitable for use as a key in authentication and account management.
* Must not be {@code null}.
*
* @throws IllegalArgumentException If any argument does not meet its
* preconditions.
Expand Down Expand Up @@ -77,7 +84,7 @@ public UserInfoResult() {
}

/**
* Last name of user.
* Last name of the user.
*
* @return value for this field, or {@code null} if not present.
*/
Expand All @@ -87,7 +94,7 @@ public String getFamilyName() {
}

/**
* First name of user.
* First name of the user.
*
* @return value for this field, or {@code null} if not present.
*/
Expand All @@ -97,7 +104,12 @@ public String getGivenName() {
}

/**
* Email address of user.
* The user's email address. Be aware it's possible that the user has since
* lost access to their email. Note: email is not a unique or stable
* identifier for a Dropbox account. Users can change their email, and
* emails can be reused by different accounts. Apps should not use email as
* a key for account identification; use {@link UserInfoResult#getSub}
* instead.
*
* @return value for this field, or {@code null} if not present.
*/
Expand All @@ -107,7 +119,7 @@ public String getEmail() {
}

/**
* If user is email verified.
* If the user's email address is verified.
*
* @return value for this field, or {@code null} if not present.
*/
Expand All @@ -117,7 +129,7 @@ public Boolean getEmailVerified() {
}

/**
* Issuer of token (in this case Dropbox).
* Issuer of the token (in this case Dropbox).
*
* @return value for this field, or {@code null} if not present. Defaults to
* "".
Expand All @@ -129,7 +141,9 @@ public String getIss() {

/**
* An identifier for the user. This is the Dropbox account_id, a string
* value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc.
* value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc. The account_id is
* a unique and stable identifier for a Dropbox account, suitable for use as
* a key in authentication and account management.
*
* @return value for this field, or {@code null} if not present. Defaults to
* "".
Expand Down Expand Up @@ -172,7 +186,7 @@ protected Builder() {
/**
* Set value for optional field.
*
* @param familyName Last name of user.
* @param familyName Last name of the user.
*
* @return this builder
*/
Expand All @@ -184,7 +198,7 @@ public Builder withFamilyName(String familyName) {
/**
* Set value for optional field.
*
* @param givenName First name of user.
* @param givenName First name of the user.
*
* @return this builder
*/
Expand All @@ -196,7 +210,12 @@ public Builder withGivenName(String givenName) {
/**
* Set value for optional field.
*
* @param email Email address of user.
* @param email The user's email address. Be aware it's possible that
* the user has since lost access to their email. Note: email is not
* a unique or stable identifier for a Dropbox account. Users can
* change their email, and emails can be reused by different
* accounts. Apps should not use email as a key for account
* identification; use {@link UserInfoResult#getSub} instead.
*
* @return this builder
*/
Expand All @@ -208,7 +227,7 @@ public Builder withEmail(String email) {
/**
* Set value for optional field.
*
* @param emailVerified If user is email verified.
* @param emailVerified If the user's email address is verified.
*
* @return this builder
*/
Expand All @@ -223,7 +242,7 @@ public Builder withEmailVerified(Boolean emailVerified) {
* <p> If left unset or set to {@code null}, defaults to {@code ""}.
* </p>
*
* @param iss Issuer of token (in this case Dropbox). Must not be
* @param iss Issuer of the token (in this case Dropbox). Must not be
* {@code null}. Defaults to {@code ""} when set to {@code null}.
*
* @return this builder
Expand All @@ -249,8 +268,10 @@ public Builder withIss(String iss) {
*
* @param sub An identifier for the user. This is the Dropbox
* account_id, a string value such as
* dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc. Must not be {@code
* null}. Defaults to {@code ""} when set to {@code null}.
* dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc. The account_id is a
* unique and stable identifier for a Dropbox account, suitable for
* use as a key in authentication and account management. Must not
* be {@code null}. Defaults to {@code ""} when set to {@code null}.
*
* @return this builder
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,18 @@ public class Account {
* The amount of detail revealed about an account depends on the user being
* queried and the user making the query.
*
* @param accountId The user's unique Dropbox ID. Must have length of at
* least 40, have length of at most 40, and not be {@code null}.
* @param accountId The user's unique and stable Dropbox ID. Must have
* length of at least 40, have length of at most 40, and not be {@code
* null}.
* @param name Details of a user's name. Must not be {@code null}.
* @param email The user's email address. Do not rely on this without
* checking the {@link Account#getEmailVerified} field. Even then, it's
* possible that the user has since lost access to their email. Must not
* be {@code null}.
* possible that the user has since lost access to their email. Note:
* email is not a unique or stable identifier for a Dropbox account.
* Users can change their email, and emails can be reused by different
* accounts. Apps should not use email as a key for account
* identification; use {@link Account#getAccountId} instead. Must not be
* {@code null}.
* @param emailVerified Whether the user has verified their email address.
* @param disabled Whether the user has been disabled.
* @param profilePhotoUrl URL for the photo representing the user, if one
Expand Down Expand Up @@ -86,13 +91,18 @@ public Account(@Nonnull String accountId, @Nonnull Name name, @Nonnull String em
*
* <p> The default values for unset fields will be used. </p>
*
* @param accountId The user's unique Dropbox ID. Must have length of at
* least 40, have length of at most 40, and not be {@code null}.
* @param accountId The user's unique and stable Dropbox ID. Must have
* length of at least 40, have length of at most 40, and not be {@code
* null}.
* @param name Details of a user's name. Must not be {@code null}.
* @param email The user's email address. Do not rely on this without
* checking the {@link Account#getEmailVerified} field. Even then, it's
* possible that the user has since lost access to their email. Must not
* be {@code null}.
* possible that the user has since lost access to their email. Note:
* email is not a unique or stable identifier for a Dropbox account.
* Users can change their email, and emails can be reused by different
* accounts. Apps should not use email as a key for account
* identification; use {@link Account#getAccountId} instead. Must not be
* {@code null}.
* @param emailVerified Whether the user has verified their email address.
* @param disabled Whether the user has been disabled.
*
Expand All @@ -104,7 +114,7 @@ public Account(@Nonnull String accountId, @Nonnull Name name, @Nonnull String em
}

/**
* The user's unique Dropbox ID.
* The user's unique and stable Dropbox ID.
*
* @return value for this field, never {@code null}.
*/
Expand All @@ -126,7 +136,11 @@ public Name getName() {
/**
* The user's email address. Do not rely on this without checking the {@link
* Account#getEmailVerified} field. Even then, it's possible that the user
* has since lost access to their email.
* has since lost access to their email. Note: email is not a unique or
* stable identifier for a Dropbox account. Users can change their email,
* and emails can be reused by different accounts. Apps should not use email
* as a key for account identification; use {@link Account#getAccountId}
* instead.
*
* @return value for this field, never {@code null}.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,18 @@ public class BasicAccount extends Account {
* <p> Use {@link newBuilder} to create instances of this class without
* specifying values for all optional fields. </p>
*
* @param accountId The user's unique Dropbox ID. Must have length of at
* least 40, have length of at most 40, and not be {@code null}.
* @param accountId The user's unique and stable Dropbox ID. Must have
* length of at least 40, have length of at most 40, and not be {@code
* null}.
* @param name Details of a user's name. Must not be {@code null}.
* @param email The user's email address. Do not rely on this without
* checking the {@link Account#getEmailVerified} field. Even then, it's
* possible that the user has since lost access to their email. Must not
* be {@code null}.
* possible that the user has since lost access to their email. Note:
* email is not a unique or stable identifier for a Dropbox account.
* Users can change their email, and emails can be reused by different
* accounts. Apps should not use email as a key for account
* identification; use {@link Account#getAccountId} instead. Must not be
* {@code null}.
* @param emailVerified Whether the user has verified their email address.
* @param disabled Whether the user has been disabled.
* @param isTeammate Whether this user is a teammate of the current user.
Expand All @@ -67,13 +72,18 @@ public BasicAccount(@Nonnull String accountId, @Nonnull Name name, @Nonnull Stri
*
* <p> The default values for unset fields will be used. </p>
*
* @param accountId The user's unique Dropbox ID. Must have length of at
* least 40, have length of at most 40, and not be {@code null}.
* @param accountId The user's unique and stable Dropbox ID. Must have
* length of at least 40, have length of at most 40, and not be {@code
* null}.
* @param name Details of a user's name. Must not be {@code null}.
* @param email The user's email address. Do not rely on this without
* checking the {@link Account#getEmailVerified} field. Even then, it's
* possible that the user has since lost access to their email. Must not
* be {@code null}.
* possible that the user has since lost access to their email. Note:
* email is not a unique or stable identifier for a Dropbox account.
* Users can change their email, and emails can be reused by different
* accounts. Apps should not use email as a key for account
* identification; use {@link Account#getAccountId} instead. Must not be
* {@code null}.
* @param emailVerified Whether the user has verified their email address.
* @param disabled Whether the user has been disabled.
* @param isTeammate Whether this user is a teammate of the current user.
Expand All @@ -88,7 +98,7 @@ public BasicAccount(@Nonnull String accountId, @Nonnull Name name, @Nonnull Stri
}

/**
* The user's unique Dropbox ID.
* The user's unique and stable Dropbox ID.
*
* @return value for this field, never {@code null}.
*/
Expand All @@ -110,7 +120,11 @@ public Name getName() {
/**
* The user's email address. Do not rely on this without checking the {@link
* Account#getEmailVerified} field. Even then, it's possible that the user
* has since lost access to their email.
* has since lost access to their email. Note: email is not a unique or
* stable identifier for a Dropbox account. Users can change their email,
* and emails can be reused by different accounts. Apps should not use email
* as a key for account identification; use {@link Account#getAccountId}
* instead.
*
* @return value for this field, never {@code null}.
*/
Expand Down Expand Up @@ -172,13 +186,18 @@ public String getTeamMemberId() {
/**
* Returns a new builder for creating an instance of this class.
*
* @param accountId The user's unique Dropbox ID. Must have length of at
* least 40, have length of at most 40, and not be {@code null}.
* @param accountId The user's unique and stable Dropbox ID. Must have
* length of at least 40, have length of at most 40, and not be {@code
* null}.
* @param name Details of a user's name. Must not be {@code null}.
* @param email The user's email address. Do not rely on this without
* checking the {@link Account#getEmailVerified} field. Even then, it's
* possible that the user has since lost access to their email. Must not
* be {@code null}.
* possible that the user has since lost access to their email. Note:
* email is not a unique or stable identifier for a Dropbox account.
* Users can change their email, and emails can be reused by different
* accounts. Apps should not use email as a key for account
* identification; use {@link Account#getAccountId} instead. Must not be
* {@code null}.
* @param emailVerified Whether the user has verified their email address.
* @param disabled Whether the user has been disabled.
* @param isTeammate Whether this user is a teammate of the current user.
Expand Down
Loading
Loading