GithubAuthProvider class

Proveedor para generar una OAuthCredential para el ProviderId.GITHUB.

GitHub requiere un redireccionamiento de OAuth 2.0, por lo que puedes controlar el redireccionamiento directamente o usar el controlador signInWithPopup():

Firma:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Extiende: BaseOAuthProvider

Constructores

Constructor	Teclas modificadoras	Descripción
(constructor)()		Construye una instancia nueva de la clase GithubAuthProvider.

Propiedades

Propiedad	Teclas modificadoras	Tipo	Descripción
MÉTODO_DE_GITHUB_SIGN_IN_METHOD	static	“github.com”	Siempre se debe establecer en SignInMethod.GITHUB.
ID_PROVEEDOR	static	“github.com”	Siempre se establece en ProviderId.GITHUB.

Métodos

Método	Teclas modificadoras	Descripción
credential(accessToken)	static	Crea una credencial para GitHub.
credentialFromError(error)	static	Se usa para extraer la OAuthCredential subyacente de un AuthError que se haya producido durante una operación de acceso, vínculo o nueva autenticación.
credentialFromResult(userCredential)	static	Se usa para extraer la OAuthCredential subyacente de una UserCredential.

GithubAuthProvider.(constructor)

Construye una instancia nueva de la clase GithubAuthProvider.

Firma:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Siempre se debe establecer en SignInMethod.GITHUB.

Firma:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Siempre se establece en ProviderId.GITHUB.

Firma:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Crea una credencial para GitHub.

Firma:

static credential(accessToken: string): OAuthCredential;

Parámetros

Parámetro	Tipo	Descripción
accessToken	string	Token de acceso de GitHub.

Muestra:

OAuthCredential

GithubAuthProvider.credentialFromError()

Se usa para extraer la OAuthCredential subyacente de un AuthError que se haya producido durante una operación de acceso, vínculo o nueva autenticación.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
error	FirebaseError.

Muestra:

OAuthCredential | nulo

GithubAuthProvider.credentialFromResult()

Se usa 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	Es la credencial de usuario.

Muestra:

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