ProviderId.GITHUB için OAuthCredential oluşturan sağlayıcı.
GitHub'da OAuth 2.0 yönlendirmesi gerekir. Böylece yönlendirmeyi doğrudan işleyebilir veya signInWithPopup() işleyicisini kullanabilirsiniz:
İmza:
export declare class GithubAuthProvider extends BaseOAuthProvider
Genişletir: BaseOAuthProvider
Markalar
Marka | Değiştiriciler | Açıklama |
---|---|---|
(buildor)() | GithubAuthProvider sınıfının yeni bir örneğini oluşturur |
Özellikler
Özellik | Değiştiriciler | Tür | Açıklama |
---|---|---|---|
GITHUB_SIGN_IN_METHOD | static |
"github.com" | Her zaman SignInMethod.GITHUB olarak ayarlayın. |
SAĞLAYICI_KİMLİĞİ | static |
"github.com" | Her zaman ProviderId.GITHUB olarak ayarlanır. |
Yöntemler
Yöntem | Değiştiriciler | Açıklama |
---|---|---|
credential(accessToken) | static |
GitHub için kimlik bilgisi oluşturur. |
credentialFromError(hata) | static |
Oturum açma, bağlantı veya yeniden kimlik doğrulama işlemi sırasında tespit edilen bir AuthError'dan temel OAuthCredential öğesini ayıklamak için kullanılır. |
credentialFromResult(userCredential) | static |
Bir UserCredential öğesinden temel OAuthCredential öğesini ayıklamak için kullanılır. |
GitHubAuthProvider.(kurucu)
GithubAuthProvider
sınıfının yeni bir örneğini oluşturur
İmza:
constructor();
GitHubAuthProvider.GITHUB_SIGN_IN_METHOD
Her zaman SignInMethod.GITHUB olarak ayarlayın.
İmza:
static readonly GITHUB_SIGN_IN_METHOD: 'github.com';
GitHubAuthProvider.SAĞLAYICI_KİMLİĞİ
Her zaman ProviderId.GITHUB olarak ayarlanır.
İmza:
static readonly PROVIDER_ID: 'github.com';
GitHubAuthProvider.credential()
GitHub için kimlik bilgisi oluşturur.
İmza:
static credential(accessToken: string): OAuthCredential;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
accessToken | dize | GitHub erişim jetonu. |
Şunu döndürür:
OAuthCredential (OAuth Kimlik Bilgisi)
GitHubAuthProvider.credentialFromError()
Oturum açma, bağlantı veya yeniden kimlik doğrulama işlemi sırasında tespit edilen bir AuthError'dan temel OAuthCredential öğesini ayıklamak için kullanılır.
İmza:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
hata | Firebase Hatası |
Şunu döndürür:
OAuthCredential | boş
GitHubAuthProvider.credentialFromResult()
Bir UserCredential öğesinden temel OAuthCredential öğesini ayıklamak için kullanılır.
İmza:
static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
kullanıcıKimlik Bilgisi | UserCredential (Kullanıcı Kimlik Bilgisi) | Kullanıcının kimlik bilgisi. |
Şunu döndürür:
OAuthCredential | boş
1. örnek
// 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;
}
2. örnek
// 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;