OAuthProvider class

Proveedor para generar OAuthCredential genéricos.

Firma:

export declare class OAuthProvider extends BaseOAuthProvider 

Extiende: BaseOAuthProvider

Métodos

Método	Teclas modificadoras	Descripción
Credential(parámetros)		Crea una OAuthCredential a partir de un token de acceso o de ID de un proveedor de OAuth genérico.
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.
credentialFromJSON(json)	static	Crea una OAuthCredential a partir de una string JSON o un objeto sin formato.
credentialFromResult(userCredential)	static	Se usa para extraer la OAuthCredential subyacente de una UserCredential.

OAuthProvider.credential()

Crea una OAuthCredential a partir de un token de acceso o de ID de un proveedor de OAuth genérico.

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

Firma:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parámetros

Parámetro	Tipo	Descripción
params	OAuthCredentialOptions	El objeto de opciones que contiene el token de ID, el token de acceso y el nonce sin procesar, o la cadena del token de ID.

Muestra:

OAuthCredential

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

OAuthProvider.credentialFromJSON()

Crea una OAuthCredential a partir de una string JSON o un objeto sin formato.

Firma:

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

Parámetros

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

Muestra:

OAuthCredential

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