Dostawca służący do generowania OAuthCredential dla ProviderId .GITHUB.
GitHub wymaga przekierowania OAuth 2.0, więc możesz obsłużyć przekierowanie bezpośrednio lub użyć procedury obsługi SignInWithPopup() :
Podpis:
export declare class GithubAuthProvider extends BaseOAuthProvider
Rozszerza: BaseOAuthProvider
Konstruktorzy
Konstruktor | Modyfikatory | Opis |
---|---|---|
(konstruktor)() | Konstruuje nowe wystąpienie klasy GithubAuthProvider |
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
GITHUB_SIGN_IN_METHOD | static | „github.com” | Zawsze ustaw na SignInMethod .GITHUB. |
PROVIDER_ID | static | „github.com” | Zawsze ustawione na ProviderId .GITHUB. |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
dane uwierzytelniające (token dostępu) | static | Tworzy dane uwierzytelniające dla Githuba. |
referencjaFromError(błąd) | static | Służy do wyodrębniania podstawowego OAuthCredential z AuthError , który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania. |
dane uwierzytelniająceFromResult(poświadczenia użytkownika) | static | Służy do wyodrębniania podstawowego OAuthCredential z UserCredential . |
GithubAuthProvider.(konstruktor)
Konstruuje nowe wystąpienie klasy GithubAuthProvider
Podpis:
constructor();
GithubAuthProvider.GITHUB_SIGN_IN_METHOD
Zawsze ustaw na SignInMethod .GITHUB.
Podpis:
static readonly GITHUB_SIGN_IN_METHOD: 'github.com';
GithubAuthProvider.PROVIDER_ID
Zawsze ustawione na ProviderId .GITHUB.
Podpis:
static readonly PROVIDER_ID: 'github.com';
GithubAuthProvider.credential()
Tworzy dane uwierzytelniające dla Githuba.
Podpis:
static credential(accessToken: string): OAuthCredential;
Parametry
Parametr | Typ | Opis |
---|---|---|
token dostępu | strunowy | Token dostępu Github. |
Zwroty:
GithubAuthProvider.credentialFromError()
Służy do wyodrębniania podstawowego OAuthCredential z AuthError , który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.
Podpis:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
Parametry
Parametr | Typ | Opis |
---|---|---|
błąd | Błąd Firebase |
Zwroty:
Poświadczenie OAuth | zero
GithubAuthProvider.credentialFromResult()
Służy do wyodrębniania podstawowego OAuthCredential z UserCredential .
Podpis:
static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
Parametry
Parametr | Typ | Opis |
---|---|---|
Poświadczenie użytkownika | Poświadczenia użytkownika | Poświadczenia użytkownika. |
Zwroty:
Poświadczenie OAuth | zero
Przykład 1
// 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 = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;
}
Przykład 2
// Sign in using a popup.
const provider = new GithubAuthProvider();
provider.addScope('repo');
const result = await signInWithPopup(auth, provider);
// The signed-in user info.
const user = result.user;
// This gives you a Github Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;