OAuthProvider class

موفّر بيانات لإنشاء بيانات اعتماد OAuth عامة.

Signature:

export declare class OAuthProvider extends BaseOAuthProvider 

الإضافات: BaseOAuthProvider

الطُرق

الطريقة	المعدِّلات	الوصف
بيانات الاعتماد(المَعلمات)		ينشئ بيانات اعتماد OAuth من رمز الوصول أو رمز المعرّف العام لموفِّر OAuth العام.
CredentialFromError(error)	static	يتم استخدام البيانات لاستخراج OAuthCredential الأساسي من AuthError الذي تم عرضه أثناء تسجيل الدخول أو الربط أو عملية إعادة المصادقة.
CredentialFromJSON(json)	static	يُنشئ بيانات اعتماد OAuth من سلسلة JSON أو كائن عادي.
certificationFromResult(userCredential)	static	يتم استخدام البيانات لاستخراج OAuthCredential الأساسي من UserCredential.

OAuthProvider.credit()

ينشئ بيانات اعتماد OAuth من رمز الوصول أو رمز المعرّف العام لموفِّر OAuth العام.

تكون القيمة غير التلقائية مطلوبة عندما يتم توفير رمز مميّز للمعرّف مع حقل nonce. يجب أن تتطابق تجزئة SHA-256 لرقم التعريف الخاص الأوّلي مع حقل nonce في الرمز المميز للمعرّف.

Signature:

credential(params: OAuthCredentialOptions): OAuthCredential;

المَعلمات

المعلمة	النوع	الوصف
المَعلمات	OAuthCredentialOptions	تكون إما كائن الخيارات الذي يحتوي على الرمز المميز لرقم التعريف، ورمز الدخول ورمز خاص غير أساسي أو سلسلة الرمز المميز لرقم التعريف.

المرتجعات:

بيانات اعتماد OAuth

مثال

// `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 الذي تم عرضه أثناء تسجيل الدخول أو الربط أو عملية إعادة المصادقة.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
خطأ	خطأ Firebase

المرتجعات:

بيانات اعتماد OAuth | فارغ

OAuthProvider.CredentialFromJSON()

يُنشئ بيانات اعتماد OAuth من سلسلة JSON أو كائن عادي.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
ملف JSON	كائن | سلسلة	كائن عادي أو سلسلة JSON

المرتجعات:

بيانات اعتماد OAuth

OAuthProvider.certifiedFromResult()

يتم استخدام البيانات لاستخراج OAuthCredential الأساسي من UserCredential.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
بيانات اعتماد المستخدم	UserCredential	بيانات اعتماد المستخدم

المرتجعات:

بيانات اعتماد OAuth | فارغ

مثال 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;