OAuthProvider class

Provedor para gerar uma OAuthCredential genérica.

Assinatura:

export declare class OAuthProvider extends BaseOAuthProvider 

Estende:BaseOAuthProvider

Métodos

Método	Modificadores	Descrição
credencial(parâmetros)		Cria um OAuthCredential com base no token de acesso ou de ID de um provedor OAuth genérico.
credentialFromError(error)	static	Usado para extrair a OAuthCredential subjacente de um AuthError gerado durante uma operação de login, link ou reautenticação.
credentialFromJSON(json) (link em inglês)	static	Cria uma OAuthCredential com base em uma string JSON ou um objeto simples.
credentialFromResult(userCredential) (link em inglês)	static	Usado para extrair a OAuthCredential subjacente de uma UserCredential.

OAuthProvider.credential()

Cria um OAuthCredential com base no token de acesso ou de ID de um provedor OAuth genérico.

O valor de uso único bruto é necessário quando um token de ID com um campo de valor de uso único é fornecido. O hash SHA-256 do valor de uso único bruto precisa corresponder ao campo do valor de uso único no token de ID.

Assinatura:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parâmetros

Parâmetro	Tipo	Descrição
params	OAuthCredentialOptions.	O objeto de opções que contém o token de ID, o token de acesso e o valor de uso único bruto ou a string do token de ID.

Retorna:

OAuthCredential

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 a OAuthCredential subjacente de um AuthError 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
error	FirebaseError (em inglês)

Retorna:

OAuthCredential | nulo

OAuthProvider.credentialFromJSON()

Cria uma OAuthCredential com base em uma string JSON ou 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:

OAuthCredential

OAuthProvider.credentialFromResult()

Usado para extrair a OAuthCredential subjacente de uma UserCredential.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
Credencialdeusuário	UserCredential (em inglês)	A credencial do usuário.

Retorna:

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