Skip to content

Auth Javadoc edits #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 3, 2021
Merged

Auth Javadoc edits #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
647e9f3
Javadoc edits
kevinthecheung Apr 30, 2021
ee5eb26
AbstractFirebaseAuth docstring edits
kevinthecheung Apr 30, 2021
0234c55
Update src/main/java/com/google/firebase/auth/UserRecord.java
kevinthecheung Apr 30, 2021
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
8 changes: 4 additions & 4 deletions src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,9 +555,9 @@ protected UserRecord execute() throws FirebaseAuthException {
}

/**
* Gets the user data for the user corresponding to a given provider id.
* Gets the user data for the user corresponding to a given provider ID.
*
* @param providerId Identifier for the given federated provider, for example,
* @param providerId Identifier for the given federated provider: for example,
* "google.com" for the Google provider.
* @param uid The user identifier with the given provider.
* @return A {@link UserRecord} instance.
Expand All @@ -571,9 +571,9 @@ public UserRecord getUserByProviderUid(
}

/**
* Gets the user data for the user corresponding to a given provider id.
* Gets the user data for the user corresponding to a given provider ID.
*
* @param providerId Identifer for the given federated provider, for example,
* @param providerId Identifer for the given federated provider: for example,
* "google.com" for the Google provider.
* @param uid The user identifier with the given provider.
* @return An {@code ApiFuture} which will complete successfully with a {@link UserRecord}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/google/firebase/auth/UserRecord.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,8 +576,8 @@ public UpdateRequest setCustomClaims(Map<String,Object> customClaims) {
*
* <p>Linking a provider to an existing user account does not invalidate the
* refresh token of that account. In other words, the existing account
* would continue to be able to access resources, despite not having used
* the newly linked provider to log in. If you wish to force the user to
* continues to be able to access resources, despite not having used
* the newly linked provider to sign in. If you wish to force the user to
* authenticate with this new provider, you need to (a) revoke their
* refresh token (see
* https://firebase.google.com/docs/auth/admin/manage-sessions#revoke_refresh_tokens),
Expand Down