Update examples to account for change in API related to credentialFromResult

Author: avolkovi

common/api-review/auth-exp.api.md

@@ -318,9 +318,7 @@ export class EmailAuthProvider implements externs.EmailAuthProvider {
 // @public
 export class FacebookAuthProvider extends OAuthProvider {
     static credential(accessToken: string): externs.OAuthCredential;
-    // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
-    // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
     static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK;
     static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK;
@@ -351,9 +349,7 @@ export function getRedirectResult(auth: externs.Auth, resolver?: externs.PopupRe
 // @public
 export class GithubAuthProvider extends OAuthProvider {
     static credential(accessToken: string): externs.OAuthCredential;
-    // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
-    // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
     static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB;
     static readonly PROVIDER_ID = externs.ProviderId.GITHUB;
@@ -363,9 +359,7 @@ export class GithubAuthProvider extends OAuthProvider {
 // @public
 export class GoogleAuthProvider extends OAuthProvider {
     static credential(idToken?: string | null, accessToken?: string | null): externs.OAuthCredential;
-    // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
-    // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
     static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE;
     static readonly PROVIDER_ID = externs.ProviderId.GOOGLE;
@@ -584,9 +578,7 @@ export function signOut(auth: externs.Auth): Promise<void>;
 // @public
 export class TwitterAuthProvider extends OAuthProvider {
     static credential(token: string, secret: string): externs.OAuthCredential;
-    // (undocumented)
     static credentialFromError(error: FirebaseError): externs.OAuthCredential | null;
-    // (undocumented)
     static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null;
     // (undocumented)
     static readonly PROVIDER_ID = externs.ProviderId.TWITTER;

docs-exp/auth.facebookauthprovider.credentialfromerror.md

@@ -4,6 +4,8 @@
 
 ## FacebookAuthProvider.credentialFromError() method
 
+Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth.facebookauthprovider.credentialfromresult.md

@@ -4,6 +4,8 @@
 
 ## FacebookAuthProvider.credentialFromResult() method
 
+Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  userCredential | externs.[UserCredential](./auth-types.usercredential.md) |  |
+|  userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. |
 
 <b>Returns:</b>
 

docs-exp/auth.facebookauthprovider.md

@@ -18,17 +18,21 @@ export declare class FacebookAuthProvider extends OAuthProvider
 
 ```javascript
 // Sign in using a redirect.
-const result = await getRedirectResult(auth);
-if (result.credential) {
-  // This gives you a Google Access Token.
-  const token = result.credential.accessToken;
-}
-const user = result.user;
-
-// Start a sign in process for an unauthenticated user.
 const provider = new FacebookAuthProvider();
+// Start a sign in process for an unauthenticated user.
 provider.addScope('user_birthday');
 await signInWithRedirect(auth, provider);
+// This will trigger a full page redirect away from your app
+
+// After returning from the redirect when your app initializes you can obtain the result
+const result = await getRedirectResult(auth);
+if (result) {
+  // This is the signed-in user
+  const user = result.user;
+  // This gives you a Facebook Access Token.
+  const credential = provider.credentialFromResult(auth, result);
+  const token = credential.accessToken;
+}
 
 ```
 
@@ -40,10 +44,12 @@ await signInWithRedirect(auth, provider);
 const provider = new FacebookAuthProvider();
 provider.addScope('user_birthday');
 const result = await signInWithPopup(auth, provider);
-// This gives you a Facebook Access Token.
-const token = result.credential.accessToken;
+
 // The signed-in user info.
 const user = result.user;
+// This gives you a Facebook Access Token.
+const credential = provider.credentialFromResult(auth, result);
+const token = credential.accessToken;
 
 ```
 
@@ -60,6 +66,6 @@ const user = result.user;
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [credential(accessToken)](./auth.facebookauthprovider.credential.md) | <code>static</code> | Creates a credential for Facebook. |
-|  [credentialFromError(error)](./auth.facebookauthprovider.credentialfromerror.md) | <code>static</code> |  |
-|  [credentialFromResult(userCredential)](./auth.facebookauthprovider.credentialfromresult.md) | <code>static</code> |  |
+|  [credentialFromError(error)](./auth.facebookauthprovider.credentialfromerror.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. |
+|  [credentialFromResult(userCredential)](./auth.facebookauthprovider.credentialfromresult.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md)<!-- -->. |
 

docs-exp/auth.getredirectresult.md

@@ -31,23 +31,23 @@ If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, f
 
 
 ```javascript
-// First, we perform the signInWithRedirect.
-// Creates the provider.
+// Sign in using a redirect.
 const provider = new FacebookAuthProvider();
 // You can add additional scopes to the provider:
-provider.addScope('email');
-provider.addScope('user_friends');
-// Sign in with redirect:
-await signInWithRedirect(auth, provider)
-////////////////////////////////////////////////////////////
-// The user is redirected to the provider's sign in flow...
-////////////////////////////////////////////////////////////
-// Then redirected back to the app, where we check the redirect result:
+provider.addScope('user_birthday');
+// Start a sign in process for an unauthenticated user.
+await signInWithRedirect(auth, provider);
+// This will trigger a full page redirect away from your app
+
+// After returning from the redirect when your app initializes you can obtain the result
 const result = await getRedirectResult(auth);
-// The Firebase User instance:
-const user = result.user;
-// The Facebook AuthCredential containing the Facebook access token:
-const credential = result.credential;
+if (result) {
+  // This is the signed-in user
+  const user = result.user;
+  // This gives you a Facebook Access Token.
+  const credential = provider.credentialFromResult(auth, result);
+  const token = credential.accessToken;
+}
 // As this API can be used for sign-in, linking and reauthentication,
 // check the operationType to determine what triggered this redirect
 // operation.

docs-exp/auth.githubauthprovider.credentialfromerror.md

@@ -4,6 +4,8 @@
 
 ## GithubAuthProvider.credentialFromError() method
 
+Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth.githubauthprovider.credentialfromresult.md

@@ -4,6 +4,8 @@
 
 ## GithubAuthProvider.credentialFromResult() method
 
+Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  userCredential | externs.[UserCredential](./auth-types.usercredential.md) |  |
+|  userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. |
 
 <b>Returns:</b>
 

docs-exp/auth.githubauthprovider.md

@@ -21,33 +21,39 @@ GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect dir
 
 
 ```javascript
-// Using a redirect.
-const result = await getRedirectResult(auth);
-if (result.credential) {
-  // This gives you a GitHub Access Token.
-  const token = result.credential.accessToken;
-}
-const user = result.user;
-
-// Start a sign in process for an unauthenticated user.
+// Sign in using a redirect.
 const provider = new GithubAuthProvider();
+// Start a sign in process for an unauthenticated user.
 provider.addScope('repo');
 await signInWithRedirect(auth, provider);
+// This will trigger a full page redirect away from your app
+
+// After returning from the redirect when your app initializes you can obtain the result
+const result = await getRedirectResult(auth);
+if (result) {
+  // This is the signed-in user
+  const user = result.user;
+  // This gives you a Github Access Token.
+  const credential = provider.credentialFromResult(auth, result);
+  const token = credential.accessToken;
+}
 
 ```
 
 ## Example 2
 
 
 ```javascript
-// With popup.
+// Sign in using a popup.
 const provider = new GithubAuthProvider();
 provider.addScope('repo');
 const result = await signInWithPopup(auth, provider);
-// This gives you a GitHub Access Token.
-const token = result.credential.accessToken;
+
 // The signed-in user info.
 const user = result.user;
+// This gives you a Github Access Token.
+const credential = provider.credentialFromResult(auth, result);
+const token = credential.accessToken;
 
 ```
 
@@ -64,6 +70,6 @@ const user = result.user;
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [credential(accessToken)](./auth.githubauthprovider.credential.md) | <code>static</code> | Creates a credential for Github. |
-|  [credentialFromError(error)](./auth.githubauthprovider.credentialfromerror.md) | <code>static</code> |  |
-|  [credentialFromResult(userCredential)](./auth.githubauthprovider.credentialfromresult.md) | <code>static</code> |  |
+|  [credentialFromError(error)](./auth.githubauthprovider.credentialfromerror.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. |
+|  [credentialFromResult(userCredential)](./auth.githubauthprovider.credentialfromresult.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md)<!-- -->. |
 

docs-exp/auth.googleauthprovider.credentialfromerror.md

@@ -4,6 +4,8 @@
 
 ## GoogleAuthProvider.credentialFromError() method
 
+Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation.
+
 <b>Signature:</b>
 
 ```typescript

docs-exp/auth.googleauthprovider.credentialfromresult.md

@@ -4,6 +4,8 @@
 
 ## GoogleAuthProvider.credentialFromResult() method
 
+Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md)<!-- -->.
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  userCredential | externs.[UserCredential](./auth-types.usercredential.md) |  |
+|  userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. |
 
 <b>Returns:</b>
 

docs-exp/auth.googleauthprovider.md

@@ -17,19 +17,23 @@ export declare class GoogleAuthProvider extends OAuthProvider
 
 
 ```javascript
-// Using a redirect.
-const result = getRedirectResult(auth);
-if (result.credential) {
-  // This gives you a Google Access Token.
-  const token = result.credential.accessToken;
-}
-const user = result.user;
-
+// Sign in using a redirect.
+const provider = new GoogleAuthProvider();
 // Start a sign in process for an unauthenticated user.
-var provider = new GoogleAuthProvider();
 provider.addScope('profile');
 provider.addScope('email');
-aiwait signInWithRedirect(auth, provider);
+await signInWithRedirect(auth, provider);
+// This will trigger a full page redirect away from your app
+
+// After returning from the redirect when your app initializes you can obtain the result
+const result = await getRedirectResult(auth);
+if (result) {
+  // This is the signed-in user
+  const user = result.user;
+  // This gives you a Google Access Token.
+  const credential = provider.credentialFromResult(auth, result);
+  const token = credential.accessToken;
+}
 
 ```
 
@@ -42,10 +46,12 @@ const provider = new GoogleAuthProvider();
 provider.addScope('profile');
 provider.addScope('email');
 const result = await signInWithPopup(auth, provider);
-// This gives you a Google Access Token.
-const token = result.credential.accessToken;
+
 // The signed-in user info.
 const user = result.user;
+// This gives you a Google Access Token.
+const credential = provider.credentialFromResult(auth, result);
+const token = credential.accessToken;
 
 ```
 
@@ -62,6 +68,6 @@ const user = result.user;
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [credential(idToken, accessToken)](./auth.googleauthprovider.credential.md) | <code>static</code> | Creates a credential for Google. At least one of ID token and access token is required. |
-|  [credentialFromError(error)](./auth.googleauthprovider.credentialfromerror.md) | <code>static</code> |  |
-|  [credentialFromResult(userCredential)](./auth.googleauthprovider.credentialfromresult.md) | <code>static</code> |  |
+|  [credentialFromError(error)](./auth.googleauthprovider.credentialfromerror.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. |
+|  [credentialFromResult(userCredential)](./auth.googleauthprovider.credentialfromresult.md) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md)<!-- -->. |
 

docs-exp/auth.linkwithpopup.md

@@ -28,3 +28,15 @@ Promise&lt;externs.[UserCredential](./auth-types.usercredential.md)<!-- -->&gt;
 
 If the linking is successful, the returned result will contain the user and the provider's credential.
 
+## Example
+
+
+```javascript
+// Sign in using some other provider.
+const result = await signInWithEmailAndPassword(auth, email, password);
+// Link using a popup.
+const provider = new FacebookAuthProvider();
+await linkWithPopup(result.user, provider);
+
+```
+

docs-exp/auth.linkwithredirect.md

@@ -24,3 +24,19 @@ export declare function linkWithRedirect(user: externs.User, provider: externs.A
 
 Promise<never>
 
+## Example
+
+
+```javascript
+// Sign in using some other provider.
+const result = await signInWithEmailAndPassword(auth, email, password);
+// Link using a redirect.
+const provider = new FacebookAuthProvider();
+await linkWithRedirect(result.user, provider);
+// This will trigger a full page redirect away from your app
+
+// After returning from the redirect when your app initializes you can obtain the result
+const result = await getRedirectResult(auth);
+
+```
+