OAuthProvider class

Dostawca do generowania ogólnego atrybutu OAuthCredential.

Podpis:

export declare class OAuthProvider extends BaseOAuthProvider

Rozszerza: BaseOAuthProvider

Metody

Metoda Modyfikatory Opis
credential(params) Tworzy OAuthCredential z tokena dostępu lub identyfikatora ogólnego dostawcy OAuth.
credentialFromError(błąd) static Służy do wyodrębniania bazowych danych OAuthCredential z błędu AuthError, który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.
credentialFromJSON(json) static Tworzy OAuthCredential z ciągu znaków JSON lub zwykłego obiektu.
credentialFromResult(Dane logowania użytkownika) static Służy do wyodrębniania bazowych danych OAuthCredential z parametru UserCredential.

OAuthProvider.credential()

Tworzy OAuthCredential z tokena dostępu lub identyfikatora ogólnego dostawcy OAuth.

Nieprzetworzona wartość jednorazowa jest wymagana, jeśli podano token identyfikatora z polem liczby jednorazowej. Hasz SHA-256 nieprzetworzonej wartości jednorazowej musi pasować do pola liczby jednorazowej w tokenie identyfikatora.

Podpis:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parametry

Parametr Typ Opis
parametry OAuthCredentialOptions Obiekt options zawierający token identyfikatora, token dostępu i nieprzetworzoną liczbę jednorazową albo ciąg tokena identyfikatora.

Zwroty:

OAuthCredential

Przykład

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

Służy do wyodrębniania bazowych danych OAuthCredential z błędu AuthError, który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.

Podpis:

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

Parametry

Parametr Typ Opis
błąd Błąd Firebase

Zwroty:

OAuthCredential | wartość null

OAuthProvider.credentialFromJSON()

Tworzy OAuthCredential z ciągu znaków JSON lub zwykłego obiektu.

Podpis:

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

Parametry

Parametr Typ Opis
JSON obiekt | tekst Zwykły obiekt lub ciąg JSON

Zwroty:

OAuthCredential

OAuthProvider.credentialFromResult()

Służy do wyodrębniania bazowych danych OAuthCredential z parametru UserCredential.

Podpis:

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

Parametry

Parametr Typ Opis
userCredential UserCredential (Dane logowania użytkownika) Dane logowania użytkownika.

Zwroty:

OAuthCredential | wartość null

Przykład 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;
}

Przykład 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;