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 خام مورد نیاز است. هش SHA-256 از nonce خام باید با فیلد nonce در کد ID مطابقت داشته باشد.

امضا:

credential(params: OAuthCredentialOptions): OAuthCredential;

مولفه های

پارامتر	تایپ کنید	شرح
پارامترها	OAuthCredentialOptions	یا شیء گزینه‌ها حاوی نشانه ID، نشانه دسترسی و 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;

مولفه های

پارامتر	تایپ کنید	شرح
اعتبار کاربری	اعتبار کاربری	اعتبار کاربری

برمی گرداند:

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;