GithubAuthProvider class
Provider for generating anOAuthCredential forProviderId.GITHUB.
GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect directly, or use thesignInWithPopup() handler:
Signature:
exportdeclareclassGithubAuthProviderextendsBaseOAuthProviderExtends: BaseOAuthProvider
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)() | Constructs a new instance of theGithubAuthProvider class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| GITHUB_SIGN_IN_METHOD | static | 'github.com' | Always set toSignInMethod.GITHUB. |
| PROVIDER_ID | static | 'github.com' | Always set toProviderId.GITHUB. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| credential(accessToken) | static | Creates a credential for GitHub. |
| credentialFromError(error) | static | Used to extract the underlyingOAuthCredential from aAuthError which was thrown during a sign-in, link, or reauthenticate operation. |
| credentialFromResult(userCredential) | static | Used to extract the underlyingOAuthCredential from aUserCredential. |
GithubAuthProvider.(constructor)
Constructs a new instance of theGithubAuthProvider class
Signature:
constructor();GithubAuthProvider.GITHUB_SIGN_IN_METHOD
Always set toSignInMethod.GITHUB.
Signature:
staticreadonlyGITHUB_SIGN_IN_METHOD:'github.com';GithubAuthProvider.PROVIDER_ID
Always set toProviderId.GITHUB.
Signature:
staticreadonlyPROVIDER_ID:'github.com';GithubAuthProvider.credential()
Creates a credential for GitHub.
Signature:
staticcredential(accessToken:string):OAuthCredential;Parameters
| Parameter | Type | Description |
|---|---|---|
| accessToken | string | GitHub access token. |
Returns:
GithubAuthProvider.credentialFromError()
Used to extract the underlyingOAuthCredential from aAuthError which was thrown during a sign-in, link, or reauthenticate operation.
Signature:
staticcredentialFromError(error:FirebaseError):OAuthCredential|null;Parameters
| Parameter | Type | Description |
|---|---|---|
| error | FirebaseError |
Returns:
OAuthCredential | null
GithubAuthProvider.credentialFromResult()
Used to extract the underlyingOAuthCredential from aUserCredential.
Signature:
staticcredentialFromResult(userCredential:UserCredential):OAuthCredential|null;Parameters
| Parameter | Type | Description |
|---|---|---|
| userCredential | UserCredential | The user credential. |
Returns:
OAuthCredential | null
Example 1
// Sign in using a redirect.constprovider=newGithubAuthProvider();// Start a sign in process for an unauthenticated user.provider.addScope('repo');awaitsignInWithRedirect(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 resultconstresult=awaitgetRedirectResult(auth);if(result){// This is the signed-in userconstuser=result.user;// This gives you a GitHub Access Token.constcredential=GithubAuthProvider.credentialFromResult(result);consttoken=credential.accessToken;}Example 2
// Sign in using a popup.constprovider=newGithubAuthProvider();provider.addScope('repo');constresult=awaitsignInWithPopup(auth,provider);// The signed-in user info.constuser=result.user;// This gives you a GitHub Access Token.constcredential=GithubAuthProvider.credentialFromResult(result);consttoken=credential.accessToken;Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-01 UTC.