OAuthProvider class

Dostawca służący do generowania ogólnego protokołu OAuthCredential .

Podpis:

export declare class OAuthProvider extends BaseOAuthProvider 

Rozszerza: BaseOAuthProvider

Metody

metoda Modyfikatory Opis
dane uwierzytelniające (parametry) Tworzy OAuthCredential na podstawie tokenu dostępu lub tokenu identyfikatora ogólnego dostawcy OAuth.
referencjaFromError(błąd) static Służy do wyodrębniania podstawowego OAuthCredential z błędu AuthError , który został zgłoszony podczas operacji logowania, łączenia lub ponownego uwierzytelniania.
dane uwierzytelniająceOdJSON(json) static Tworzy OAuthCredential z ciągu JSON lub zwykłego obiektu.
dane uwierzytelniająceFromResult(poświadczenia użytkownika) static Służy do wyodrębniania podstawowego OAuthCredential z UserCredential .

OAuthProvider.credential()

Tworzy OAuthCredential na podstawie tokenu dostępu lub tokenu identyfikatora ogólnego dostawcy OAuth.

Surowa wartość jednorazowa jest wymagana w przypadku dostarczenia tokenu identyfikacyjnego z polem jednorazowym. Wartość skrótu SHA-256 surowego identyfikatora jednorazowego musi odpowiadać polu jednorazowemu w tokenie identyfikatora.

Podpis:

credential(params: OAuthCredentialOptions): OAuthCredential;

Parametry

Parametr Typ Opis
parametry Opcje OAuthCredential Albo obiekt opcji zawierający token ID, token dostępu i surową wartość jednorazową, albo ciąg tokenu ID.

Zwroty:

Poświadczenie OAuth

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 podstawowego 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:

Poświadczenie OAuth | zero

OAuthProvider.credentialFromJSON()

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

Podpis:

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

Parametry

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

Zwroty:

Poświadczenie OAuth

OAuthProvider.credentialFromResult()

Służy do wyodrębniania podstawowego OAuthCredential z UserCredential .

Podpis:

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

Parametry

Parametr Typ Opis
Poświadczenie użytkownika Poświadczenia użytkownika Poświadczenia użytkownika.

Zwroty:

Poświadczenie OAuth | zero

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;