Penyedia untuk menghasilkan OAuthCredential generik .
Tanda tangan:
export declare class OAuthProvider extends BaseOAuthProvider
Perluasan: BaseOAuthProvider
Metode
metode | Pengubah | Keterangan |
---|---|---|
kredensial (param) | Membuat OAuthCredential dari token akses atau token ID penyedia OAuth generik. | |
credentialFromError(kesalahan) | static | Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari AuthError yang muncul selama operasi masuk, menautkan, atau mengautentikasi ulang. |
kredensialDariJSON(json) | static | Membuat OAuthCredential dari string JSON atau objek biasa. |
credentialFromResult(penggunaCredential) | static | Digunakan untuk mengekstrak OAuthCredential yang mendasarinya dari UserCredential . |
OAuthProvider.kredensial()
Membuat OAuthCredential dari token akses atau token ID penyedia OAuth generik.
Nonce mentah diperlukan ketika token ID dengan bidang nonce disediakan. Hash SHA-256 dari nonce mentah harus cocok dengan kolom nonce di token ID.
Tanda tangan:
credential(params: OAuthCredentialOptions): OAuthCredential;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
param | OAuthCredentialOptions | Baik objek opsi yang berisi token ID, token akses, dan nonce mentah, atau string token ID. |
Pengembalian:
Contoh
// `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()
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
OAuthProvider.credentialFromJSON()
Membuat OAuthCredential dari string JSON atau objek biasa.
Tanda tangan:
static credentialFromJSON(json: object | string): OAuthCredential;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
json | objek | rangkaian | Objek biasa atau string JSON |
Pengembalian:
OAuthProvider.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 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;
}
Contoh 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;