GithubAuthProvider class

ProviderId için OAuthCredential oluşturmaya yönelik sağlayıcı .GITHUB.

GitHub bir OAuth 2.0 yönlendirmesi gerektirdiğinden, yönlendirmeyi doğrudan işleyebilir veya SignInWithPopup() işleyicisini kullanabilirsiniz:

İmza:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Uzatır: BaseOAuthProvider

İnşaatçılar

Oluşturucu Değiştiriciler Tanım
(yapıcı)() GithubAuthProvider sınıfının yeni bir örneğini oluşturur

Özellikler

Mülk Değiştiriciler Tip Tanım
GITHUB_SIGN_IN_METHOD static 'github.com' Her zaman SignInMethod'a ayarla .GITHUB.
PROVIDER_ID static 'github.com' Her zaman SağlayıcıKimliği olarak ayarla .GITHUB.

Yöntemler

Yöntem Değiştiriciler Tanım
kimlik bilgisi(accessToken) static Github için bir kimlik bilgisi oluşturur.
credentialFromError(hata) static Oturum açma, bağlantı kurma veya yeniden kimlik doğrulama işlemi sırasında oluşturulan bir AuthError'dan temel OAuthCredential'ı çıkarmak için kullanılır.
credentialFromResult(userCredential) static Temel OAuthCredential'ı bir UserCredential'dan çıkarmak için kullanılır .

GithubAuthProvider.(yapıcı)

GithubAuthProvider sınıfının yeni bir örneğini oluşturur

İmza:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Her zaman SignInMethod'a ayarla .GITHUB.

İmza:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Her zaman SağlayıcıKimliği olarak ayarla .GITHUB.

İmza:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Github için bir kimlik bilgisi oluşturur.

İmza:

static credential(accessToken: string): OAuthCredential;

Parametreler

Parametre Tip Tanım
erişimToken sicim Github erişim belirteci.

İadeler:

OAuthKimlik Bilgileri

GithubAuthProvider.credentialFromError()

Oturum açma, bağlantı kurma veya yeniden kimlik doğrulama işlemi sırasında oluşturulan bir AuthError'dan temel OAuthCredential'ı çıkarmak için kullanılır.

İmza:

static credentialFromError(error: FirebaseError): OAuthCredential | null;

Parametreler

Parametre Tip Tanım
hata Firebase Hatası

İadeler:

OAuthKimlik Bilgileri | hükümsüz

GithubAuthProvider.credentialFromResult()

Temel OAuthCredential'ı bir UserCredential'dan çıkarmak için kullanılır .

İmza:

static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;

Parametreler

Parametre Tip Tanım
Kullanıcı Kimlik Bilgisi Kullanıcı Kimlik Bilgileri Kullanıcı kimlik bilgisi.

İadeler:

OAuthKimlik Bilgileri | hükümsüz

örnek 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;
}

Örnek 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;