GithubAuthProvider class

Provedor para gerar um OAuthCredential para ProviderId .GITHUB.

O GitHub requer um redirecionamento OAuth 2.0, então você pode manipular o redirecionamento diretamente ou usar o manipulador signInWithPopup() :

Assinatura:

export declare class GithubAuthProvider extends BaseOAuthProvider

Estende: BaseOAuthProvider

Construtores

Construtor Modificadores Descrição
(construtor)() Constrói uma nova instância da classe GithubAuthProvider

Propriedades

Propriedade Modificadores Tipo Descrição
GITHUB_SIGN_IN_METHOD static 'github. com' Sempre definido como SignInMethod .GITHUB.
PROVIDER_ID static 'github. com' Sempre definido como ProviderId .GITHUB.

Métodos

Método Modificadores Descrição
credencial(accessToken) static Cria uma credencial para o Github.
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.
credencialFromResult(userCredential) static Usado para extrair o OAuthCredential subjacente de um UserCredential .

GithubAuthProvider.(construtor)

Constrói uma nova instância da classe GithubAuthProvider

Assinatura:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Sempre definido como SignInMethod .GITHUB.

Assinatura:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Sempre definido como ProviderId .GITHUB.

Assinatura:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Cria uma credencial para o Github.

Assinatura:

static credential(accessToken: string): OAuthCredential;

Parâmetros

Parâmetro Tipo Descrição
token de acesso corda Token de acesso do Github.

Retorna:

Credencial OAuth

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

GithubAuthProvider.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 GithubAuthProvider();
// Start a sign in process for an unauthenticated user.
provider.addScope('repo');
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 Github Access Token.
  const credential = GithubAuthProvider.credentialFromResult(result);
  const token = credential.accessToken;
}

Exemplo 2

// Sign in using a popup.
const provider = new GithubAuthProvider();
provider.addScope('repo');
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Github Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;