GithubAuthProvider class

Provedor que gera uma OAuthCredential para ProviderId.GITHUB.

O GitHub exige um redirecionamento do OAuth 2.0. Assim, você pode lidar com o redirecionamento diretamente ou usar o gerenciador signInWithPop():

Assinatura:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Estende:BaseOAuthProvider

Construtores

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

Propriedades

Propriedade	Modificadores	Tipo	Descrição
GITHUB_SIGN_IN_método (em inglês)	static	"github.com"	Sempre defina como SignInMethod.GITHUB.
PROVIDER_ID	static	"github.com"	Sempre defina como ProviderId.GITHUB.

Métodos

Método	Modificadores	Descrição
credencial(accessToken)	static	Cria uma credencial para o GitHub.
credentialFromError(error)	static	Usado para extrair a OAuthCredential subjacente de um AuthError gerado durante uma operação de login, link ou reautenticação.
credentialFromResult(userCredential) (link em inglês)	static	Usado para extrair a OAuthCredential subjacente de uma UserCredential.

GitHubAuthProvider.(construtor)

Cria uma nova instância da classe GithubAuthProvider

Assinatura:

constructor();

GitHubAuthProvider.GITHUB_SIGN_IN_method

Sempre defina como SignInMethod.GITHUB.

Assinatura:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GitHubAuthProvider.PROVIDER_ID

Sempre defina 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
accessToken	string	token de acesso do GitHub.

Retorna:

OAuthCredential

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

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