GithubAuthProvider class

Dostawca do generowania OAuthCredential dla identyfikatora ProviderId.GITHUB.

GitHub wymaga przekierowania OAuth 2.0, więc możesz je obsługiwać bezpośrednio lub użyć modułu obsługi signInWithPopup():

Podpis:

export declare class GithubAuthProvider extends BaseOAuthProvider

Rozszerza: BaseOAuthProvider

Zespoły

Zespół Modyfikatory Opis
(konstruktor)() Tworzy nową instancję klasy GithubAuthProvider

Właściwości

Właściwość Modyfikatory Typ Opis
Metoda GITHUB_SIGN_IN_METHOD static „github.com” Zawsze ustawiaj wartość SignInMethod.GITHUB.
IDENTYFIKATOR_PRODUKTU static „github.com” Zawsze ustawiona jest wartość ProviderId.GITHUB.

Metody

Metoda Modyfikatory Opis
credential(accessToken) static Tworzy dane logowania do GitHuba.
credentialFromError(błąd) static Służy do wyodrębniania bazowych danych OAuthCredential z błędu AuthError, który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.
credentialFromResult(Dane logowania użytkownika) static Służy do wyodrębniania bazowych danych OAuthCredential z parametru UserCredential.

GithubAuthProvider.(konstruktor)

Tworzy nową instancję klasy GithubAuthProvider

Podpis:

constructor();

GitHubAuthProvider.GITHUB_SIGN_IN_METHOD

Zawsze ustawiaj wartość SignInMethod.GITHUB.

Podpis:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

Identyfikator dostawcy GithubAuthProvider.PROVIDER

Zawsze ustawiona jest wartość ProviderId.GITHUB.

Podpis:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Tworzy dane logowania do GitHuba.

Podpis:

static credential(accessToken: string): OAuthCredential;

Parametry

Parametr Typ Opis
accessToken ciąg znaków Token dostępu do GitHuba.

Zwroty:

OAuthCredential

GithubAuthProvider.credentialFromError()

Służy do wyodrębniania bazowych danych OAuthCredential z błędu 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:

OAuthCredential | wartość null

GithubAuthProvider.credentialFromResult()

Służy do wyodrębniania bazowych danych OAuthCredential z parametru UserCredential.

Podpis:

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

Parametry

Parametr Typ Opis
userCredential UserCredential (Dane logowania użytkownika) Dane logowania użytkownika.

Zwroty:

OAuthCredential | wartość null

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;