Penyedia untuk menghasilkan OAuthCredential untuk ProviderId .GITHUB.
GitHub memerlukan pengalihan OAuth 2.0, sehingga Anda dapat menangani pengalihan secara langsung, atau menggunakan pengendali signInWithPopup() :
Tanda tangan:
export declare class GithubAuthProvider extends BaseOAuthProvider
Perluasan: BaseOAuthProvider
Konstruktor
Konstruktor | Pengubah | Keterangan |
---|---|---|
(konstruktor)() | Membuat instance baru dari kelas GithubAuthProvider |
Properti
Properti | Pengubah | Jenis | Keterangan |
---|---|---|---|
GITHUB_SIGN_IN_METHOD | static | 'github.com' | Selalu disetel ke SignInMethod .GITHUB. |
PROVIDER_ID | static | 'github.com' | Selalu disetel ke ProviderId .GITHUB. |
Metode
metode | Pengubah | Keterangan |
---|---|---|
kredensial (accessToken) | static | Membuat kredensial untuk Github. |
credentialFromError(kesalahan) | static | Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang muncul selama operasi masuk, menautkan, atau mengautentikasi ulang. |
credentialFromResult(penggunaCredential) | static | Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari UserCredential . |
GithubAuthProvider.(konstruktor)
Membuat instance baru dari kelas GithubAuthProvider
Tanda tangan:
constructor();
GithubAuthProvider.GITHUB_SIGN_IN_METHOD
Selalu disetel ke SignInMethod .GITHUB.
Tanda tangan:
static readonly GITHUB_SIGN_IN_METHOD: 'github.com';
GithubAuthProvider.PROVIDER_ID
Selalu disetel ke ProviderId .GITHUB.
Tanda tangan:
static readonly PROVIDER_ID: 'github.com';
GithubAuthProvider.kredensial()
Membuat kredensial untuk Github.
Tanda tangan:
static credential(accessToken: string): OAuthCredential;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
accessToken | rangkaian | Token akses Github. |
Pengembalian:
GithubAuthProvider.credentialFromError()
Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang muncul selama operasi masuk, menautkan, atau mengautentikasi ulang.
Tanda tangan:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
kesalahan | Kesalahan Firebase |
Pengembalian:
Kredensial OAuth | batal
GithubAuthProvider.credentialFromResult()
Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari UserCredential .
Tanda tangan:
static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
Kredensial pengguna | Kredensial Pengguna | Kredensial pengguna. |
Pengembalian:
Kredensial OAuth | batal
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;