GithubAuthProvider class

Proveedor para generar una OAuthCredential para ProviderId .GITHUB.

GitHub requiere una redirección de OAuth 2.0, por lo que puede 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 Escribe Descripción
GITHUB_SIGN_IN_METHOD static 'github.com' Establecido siempre en SignInMethod .GITHUB.
PROVIDER_ID static 'github.com' Establecido siempre en ProviderId .GITHUB.

Métodos

Método modificadores Descripción
credencial (token de acceso) static Crea una credencial para Github.
credencialDeError(error) static Se usa para extraer la OAuthCredential subyacente de un AuthError que se generó durante una operación de inicio de sesión, enlace o reautenticación.
credencialDeResultado(credencialusuario) static Se utiliza para extraer la OAuthCredential subyacente de una UserCredential .

GithubAuthProvider.(constructor)

Construye una nueva instancia de la clase GithubAuthProvider

Firma:

constructor();

Proveedor de autenticación Github.GITHUB_SIGN_IN_METHOD

Establecido siempre en SignInMethod .GITHUB.

Firma:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Establecido siempre 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 Escribe Descripción
token de acceso cuerda Token de acceso a Github.

Devoluciones:

OAuthCredential

GithubAuthProvider.credentialFromError()

Se usa para extraer la OAuthCredential subyacente de un AuthError que se generó durante una operación de inicio de sesión, enlace o reautenticación.

Firma:

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

Parámetros

Parámetro Escribe Descripción
error FirebaseError

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 Escribe Descripción
credencial de usuario Credencial de usuario La credencial de 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;