GithubAuthProvider class

Fournisseur permettant de générer un OAuthCredential pour ProviderId .GITHUB.

GitHub nécessite une redirection OAuth 2.0, vous pouvez donc soit gérer la redirection directement, soit utiliser le gestionnaire signInWithPopup() :

Signature:

export declare class GithubAuthProvider extends BaseOAuthProvider

Extension : BaseOAuthProvider

Constructeurs

Constructeur Modificateurs Description
(constructeur)() Construit une nouvelle instance de la classe GithubAuthProvider

Propriétés

Propriété Modificateurs Taper Description
GITHUB_SIGN_IN_METHOD static 'github.com' Toujours défini sur SignInMethod .GITHUB.
PROVIDER_ID static 'github.com' Toujours défini sur ProviderId .GITHUB.

Méthodes

Méthode Modificateurs Description
informations d'identification (accessToken) static Crée un identifiant pour Github.
informations d'identificationFromError(erreur) static Utilisé pour extraire le OAuthCredential sous-jacent d’une AuthError qui a été levée lors d’une opération de connexion, de liaison ou de réauthentification.
informations d'identificationFromResult (userCredential) static Utilisé pour extraire l' OAuthCredential sous-jacent d'un UserCredential .

GithubAuthProvider. (constructeur)

Construit une nouvelle instance de la classe GithubAuthProvider

Signature:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Toujours défini sur SignInMethod .GITHUB.

Signature:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Toujours défini sur ProviderId .GITHUB.

Signature:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Crée un identifiant pour Github.

Signature:

static credential(accessToken: string): OAuthCredential;

Paramètres

Paramètre Taper Description
jeton d'accès chaîne Jeton d'accès Github.

Retour:

OAuthCredential

GithubAuthProvider.credentialFromError()

Utilisé pour extraire le OAuthCredential sous-jacent d’une AuthError qui a été levée lors d’une opération de connexion, de liaison ou de réauthentification.

Signature:

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

Paramètres

Paramètre Taper Description
erreur Erreur Firebase

Retour:

OAuthCredential | nul

GithubAuthProvider.credentialFromResult()

Utilisé pour extraire l' OAuthCredential sous-jacent d'un UserCredential .

Signature:

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

Paramètres

Paramètre Taper Description
identifiantutilisateur Informations d'identification de l'utilisateur Les informations d'identification de l'utilisateur.

Retour:

OAuthCredential | nul

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

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