OAuthProvider class

Fournisseur de génération d'OAuthCredential générique .

Signature:

export declare class OAuthProvider extends BaseOAuthProvider

Extension : BaseOAuthProvider

Méthodes

Méthode Modificateurs Description
informations d'identification (paramètres) Crée un OAuthCredential à partir du jeton d'accès ou du jeton d'identification d'un fournisseur OAuth générique.
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'identificationFromJSON(json) static Crée un OAuthCredential à partir d'une chaîne JSON ou d'un objet simple.
informations d'identificationFromResult (userCredential) static Utilisé pour extraire l' OAuthCredential sous-jacent d'un UserCredential .

OAuthProvider.credential()

Crée un OAuthCredential à partir du jeton d'accès ou du jeton d'identification d'un fournisseur OAuth générique.

Le nom occasionnel brut est requis lorsqu'un jeton d'identification avec un champ occasionnel est fourni. Le hachage SHA-256 du nom occasionnel brut doit correspondre au champ occasionnel du jeton d'identification.

Signature:

credential(params: OAuthCredentialOptions): OAuthCredential;

Paramètres

Paramètre Taper Description
paramètres OAuthCredentialOptions Soit l'objet d'options contenant le jeton d'identification, le jeton d'accès et le nom occasionnel brut, soit la chaîne du jeton d'identification.

Retour:

OAuthCredential

Exemple

// `googleUser` from the onsuccess Google Sign In callback.
// Initialize a generate OAuth provider with a `google.com` providerId.
const provider = new OAuthProvider('google.com');
const credential = provider.credential({
  idToken: googleUser.getAuthResponse().id_token,
});
const result = await signInWithCredential(credential);

OAuthProvider.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

OAuthProvider.credentialFromJSON()

Crée un OAuthCredential à partir d'une chaîne JSON ou d'un objet simple.

Signature:

static credentialFromJSON(json: object | string): OAuthCredential;

Paramètres

Paramètre Taper Description
json objet | chaîne Un objet simple ou une chaîne JSON

Retour:

OAuthCredential

OAuthProvider.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 OAuthProvider('google.com');
// Start a sign in process for an unauthenticated user.
provider.addScope('profile');
provider.addScope('email');
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 OAuth Access Token for the provider.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}

Exemple 2

// Sign in using a popup.
const provider = new OAuthProvider('google.com');
provider.addScope('profile');
provider.addScope('email');
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a OAuth Access Token for the provider.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;