OAuthProvider class

Anbieter zum Generieren von generischem OAuthCredential .

Unterschrift:

export declare class OAuthProvider extends BaseOAuthProvider

Erweitert: BaseOAuthProvider

Methoden

Methode Modifikatoren Beschreibung
Anmeldeinformationen (Parameter) Erstellt ein OAuthCredential aus dem Zugriffstoken oder ID-Token eines generischen OAuth-Anbieters.
credentialFromError(error) static Wird verwendet, um das zugrunde liegende OAuthCredential aus einem AuthError zu extrahieren, der während einer Anmelde-, Verknüpfungs- oder Neuauthentifizierungsoperation ausgelöst wurde.
credentialFromJSON(json) static Erstellt ein OAuthCredential aus einer JSON-Zeichenfolge oder einem einfachen Objekt.
credentialFromResult(userCredential) static Wird verwendet, um das zugrunde liegende OAuthCredential aus einem UserCredential zu extrahieren .

OAuthProvider.credential()

Erstellt ein OAuthCredential aus dem Zugriffstoken oder ID-Token eines generischen OAuth-Anbieters.

Die Roh-Nonce ist erforderlich, wenn ein ID-Token mit einem Nonce-Feld bereitgestellt wird. Der SHA-256-Hash der Roh-Nonce muss mit dem Nonce-Feld im ID-Token übereinstimmen.

Unterschrift:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parameter

Parameter Typ Beschreibung
Parameter OAuthCredentialOptions Entweder das Optionsobjekt, das das ID-Token, den Zugriffstoken und die Roh-Nonce enthält, oder die ID-Token-Zeichenfolge.

Kehrt zurück:

OAuthCredential

Beispiel

// `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()

Wird verwendet, um das zugrunde liegende OAuthCredential aus einem AuthError zu extrahieren, der während einer Anmelde-, Verknüpfungs- oder Neuauthentifizierungsoperation ausgelöst wurde.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Fehler FirebaseError

Kehrt zurück:

OAuthCredential | Null

OAuthProvider.credentialFromJSON()

Erstellt ein OAuthCredential aus einer JSON-Zeichenfolge oder einem einfachen Objekt.

Unterschrift:

static credentialFromJSON(json: object | string): OAuthCredential;

Parameter

Parameter Typ Beschreibung
json Objekt | Zeichenfolge Ein einfaches Objekt oder eine JSON-Zeichenfolge

Kehrt zurück:

OAuthCredential

OAuthProvider.credentialFromResult()

Wird verwendet, um das zugrunde liegende OAuthCredential aus einem UserCredential zu extrahieren .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
userCredential Benutzeranmeldeinformationen Die Benutzeranmeldeinformationen.

Kehrt zurück:

OAuthCredential | Null

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

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