GithubAuthProvider class

Proveedor para generar una OAuthCredential para ProviderId .GITHUB.

GitHub requiere una redirección OAuth 2.0, por lo que puedes manejar la redirección directamente o usar el controlador signInWithPopup() :

Firma:

export declare class GithubAuthProvider extends BaseOAuthProvider

Extiende: BaseOAuthProvider

Constructores

Constructor Modificadores Descripción
(constructor)() Construye una nueva instancia de la clase GithubAuthProvider

Propiedades

Propiedad Modificadores Tipo Descripción
GITHUB_SIGN_IN_METHOD static 'github.com' Siempre configurado en SignInMethod .GITHUB.
PROVEEDOR_ID static 'github.com' Siempre configurado en ProviderId .GITHUB.

Métodos

Método Modificadores Descripción
credencial(token de acceso) static Crea una credencial para Github.
credencialDeError(error) static Se utiliza para extraer la OAuthCredential subyacente de un AuthError que se produjo durante una operación de inicio de sesión, vínculo o reautenticación.
credencialDeResultado(credencialdeusuario) static Se utiliza para extraer la OAuthCredential subyacente de una UserCredential .

GithubAuthProvider.(constructor)

Construye una nueva instancia de la clase GithubAuthProvider

Firma:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Siempre configurado en SignInMethod .GITHUB.

Firma:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Siempre configurado en ProviderId .GITHUB.

Firma:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credencial()

Crea una credencial para Github.

Firma:

static credential(accessToken: string): OAuthCredential;

Parámetros

Parámetro Tipo Descripción
token de acceso cadena Token de acceso a Github.

Devoluciones:

Credencial OAuth

GithubAuthProvider.credentialFromError()

Se utiliza para extraer la OAuthCredential subyacente de un AuthError que se produjo durante una operación de inicio de sesión, vínculo o reautenticación.

Firma:

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

Parámetros

Parámetro Tipo Descripción
error Error de base de fuego

Devoluciones:

Credencial OAuth | nulo

GithubAuthProvider.credentialFromResult()

Se utiliza para extraer la OAuthCredential subyacente de una UserCredential .

Firma:

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

Parámetros

Parámetro Tipo Descripción
credencial de usuario Credencial de usuario La credencial del usuario.

Devoluciones:

Credencial OAuth | nulo

Ejemplo 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;
}

Ejemplo 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;