OAuthProvider class

Provedor para gerar OAuthCredential genérico .

Assinatura:

export declare class OAuthProvider extends BaseOAuthProvider 

Estende: BaseOAuthProvider

Métodos

Método	Modificadores	Descrição
credencial (parâmetros)		Cria um OAuthCredential a partir de um token de acesso ou token de ID de um provedor OAuth genérico.
credencialFromError(erro)	static	Usado para extrair o OAuthCredential subjacente de um AuthError que foi gerado durante uma operação de login, link ou reautenticação.
credencialFromJSON(json)	static	Cria um OAuthCredential a partir de uma string JSON ou de um objeto simples.
credencialFromResult(userCredential)	static	Usado para extrair o OAuthCredential subjacente de um UserCredential .

OAuthProvider.credential()

Cria um OAuthCredential a partir de um token de acesso ou token de ID de um provedor OAuth genérico.

O nonce bruto é necessário quando um token de ID com um campo nonce é fornecido. O hash SHA-256 do nonce bruto deve corresponder ao campo nonce no token de ID.

Assinatura:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parâmetros

Parâmetro	Tipo	Descrição
parâmetros	Opções de credencial OAuth	O objeto de opções que contém o token de ID, o token de acesso e o nonce bruto ou a sequência do token de ID.

Retorna:

Credencial OAuth

Exemplo

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

Usado para extrair o OAuthCredential subjacente de um AuthError que foi gerado durante uma operação de login, link ou reautenticação.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
erro	Erro do Firebase

Retorna:

Credencial OAuth | nulo

OAuthProvider.credentialFromJSON()

Cria um OAuthCredential a partir de uma string JSON ou de um objeto simples.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
JSON	objeto | corda	Um objeto simples ou uma string JSON

Retorna:

Credencial OAuth

OAuthProvider.credentialFromResult()

Usado para extrair o OAuthCredential subjacente de um UserCredential .

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
credencial do usuário	Credencial de usuário	A credencial do usuário.

Retorna:

Credencial OAuth | nulo

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

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