GithubAuthProvider class

Penyedia untuk membuat OAuthCredential bagi ProviderId.GITHUB.

GitHub memerlukan pengalihan OAuth 2.0, sehingga Anda dapat menangani pengalihan secara langsung, atau menggunakan pengendali signInWithPop():

Tanda Tangan:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Memperluas: BaseOAuthProvider

Konstruktor

Konstruktor	Pengubah	Deskripsi
(konstruktor)()		Membuat instance baru dari class GithubAuthProvider

Properti

Properti	Pengubah	Jenis	Deskripsi
GITHUB_SIGN_IN_METHOD	static	'github.com'	Selalu tetapkan ke SignInMethod.GITHUB.
ID_PENYEDIA	static	'github.com'	Selalu tetapkan ke ProviderId.GITHUB.

Metode

Metode	Pengubah	Deskripsi
kredensial(accessToken)	static	Membuat kredensial untuk GitHub.
credentialFromError(error)	static	Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang ditampilkan selama operasi login, penautan, atau autentikasi ulang.
credentialFromResult(userCredential)	static	Digunakan untuk mengekstrak OAuthCredential dasar dari UserCredential.

GitHubAuthProvider.(konstruktor)

Membuat instance baru dari class GithubAuthProvider

Tanda Tangan:

constructor();

GitHubAuthProvider.GITHUB_SIGN_IN_METHOD

Selalu tetapkan ke SignInMethod.GITHUB.

Tanda Tangan:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GitHubAuthProvider.Provider_ID

Selalu tetapkan ke ProviderId.GITHUB.

Tanda Tangan:

static readonly PROVIDER_ID: 'github.com';

GitHubAuthProvider.credential()

Membuat kredensial untuk GitHub.

Tanda Tangan:

static credential(accessToken: string): OAuthCredential;

Parameter

Parameter	Jenis	Deskripsi
accessToken	string	Token akses GitHub.

Hasil:

OAuthCredential

GithubAuthProvider.credentialFromError()

Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang ditampilkan selama operasi login, penautan, atau autentikasi ulang.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
error	FirebaseError

Hasil:

OAuthCredential | null (kosong)

GitHubAuthProvider.credentialFromResult()

Digunakan untuk mengekstrak OAuthCredential dasar dari UserCredential.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kredensialpengguna	Kredensial Pengguna	Kredensial pengguna.

Hasil:

OAuthCredential | null (kosong)

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

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