OAuthProvider class

Proveedor para generar OAuthCredential genérico .

Firma:

export declare class OAuthProvider extends BaseOAuthProvider

Extiende: BaseOAuthProvider

Métodos

Método Modificadores Descripción
credencial(parámetros) Crea una OAuthCredential a partir del token de acceso o token de identificación de un proveedor de OAuth genérico.
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.
credencialDeJSON(json) static Crea una OAuthCredential a partir de una cadena JSON o un objeto simple.
credencialDeResultado(credencialdeusuario) static Se utiliza para extraer la OAuthCredential subyacente de una UserCredential .

OAuthProvider.credencial()

Crea una OAuthCredential a partir del token de acceso o token de identificación de un proveedor de OAuth genérico.

El nonce sin formato es necesario cuando se proporciona un token de identificación con un campo nonce. El hash SHA-256 del nonce sin procesar debe coincidir con el campo nonce en el token de ID.

Firma:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parámetros

Parámetro Tipo Descripción
parámetros Opciones de credenciales de OAuth Ya sea el objeto de opciones que contiene el token de ID, el token de acceso y el nonce sin formato o la cadena del token de ID.

Devoluciones:

Credencial OAuth

Ejemplo

// `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()

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

OAuthProvider.credentialFromJSON()

Crea una OAuthCredential a partir de una cadena JSON o un objeto simple.

Firma:

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

Parámetros

Parámetro Tipo Descripción
json objeto | cadena Un objeto simple o una cadena JSON

Devoluciones:

Credencial OAuth

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

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