OAuthProvider class

ספק להפקת OAuthCredential גנרי .

חֲתִימָה:

export declare class OAuthProvider extends BaseOAuthProvider 

מורחבת: BaseOAuthProvider

שיטות

שיטה	משנה	תיאור
אישור (פרמים)		יוצר OAuthCredential מאסימון גישה או אסימון מזהה גנרי של ספק OAuth.
credentialFromError(שגיאה)	static	משמש לחילוץ ה- OAuthCredential הבסיסי מ- AuthError שנזרק במהלך פעולת כניסה, קישור או אימות מחדש.
credentialFromJSON(json)	static	יוצר OAuthCredential ממחרוזת JSON או מאובייקט רגיל.
credentialFromResult(userCredential)	static	משמש לחילוץ ה- OAuthCredential הבסיסי מ- UserCredential .

OAuthProvider.credential()

יוצר OAuthCredential מאסימון גישה או אסימון מזהה גנרי של ספק OAuth.

ה-nonce הגולמי נדרש כאשר מסופק אסימון מזהה עם שדה nonce. ה-hash SHA-256 של nonce הגולמי חייב להתאים לשדה nonce באסימון המזהה.

חֲתִימָה:

credential(params: OAuthCredentialOptions): OAuthCredential;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
params	OAuthCredentialOptions	או אובייקט האפשרויות המכיל את אסימון ה-ID, אסימון הגישה וה-Raw nonce או מחרוזת אסימון ה-ID.

החזרות:

OAuthCredential

דוגמא

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

משמש לחילוץ ה- OAuthCredential הבסיסי מ- AuthError שנזרק במהלך פעולת כניסה, קישור או אימות מחדש.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
שְׁגִיאָה	FirebaseError

החזרות:

OAuthCredential | ריק

OAuthProvider.credentialFromJSON()

יוצר OAuthCredential ממחרוזת JSON או מאובייקט רגיל.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
json	חפץ | חוּט	אובייקט רגיל או מחרוזת JSON

החזרות:

OAuthCredential

OAuthProvider.credentialFromResult()

משמש לחילוץ ה- OAuthCredential הבסיסי מ- UserCredential .

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
UserCredential	תעודת משתמש	תעודת המשתמש.

החזרות:

OAuthCredential | ריק

דוגמה 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;
}

דוגמה 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;