GithubAuthProvider class

موفّر بيانات لإنشاء OAuthCredential لـ ProviderId.GITHUB.

يتطلب GitHub إعادة توجيه OAuth 2.0، لذا يمكنك معالجة عملية إعادة التوجيه مباشرةً، أو استخدام المعالج signInWithPopup():

Signature:

export declare class GithubAuthProvider extends BaseOAuthProvider 

الإضافات: BaseOAuthProvider

الشركات المصنِّعة

الشركة المصنِّعة	المعدِّلات	الوصف
(Buildor)()		إنشاء مثيل جديد لفئة GithubAuthProvider

أماكن إقامة

الموقع	المعدِّلات	النوع	الوصف
GITHUB_SIGN_IN_method	static	"github.com"	اضبط دائمًا على SignInMethod.GITHUB.
مين	static	"github.com"	اضبط دائمًا على ProviderId.GITHUB.

الطُرق

الطريقة	المعدِّلات	الوصف
credit(accessToken)	static	ينشئ بيانات اعتماد لـ GitHub.
CredentialFromError(error)	static	يتم استخدام البيانات لاستخراج OAuthCredential الأساسي من AuthError الذي تم عرضه أثناء تسجيل الدخول أو الربط أو عملية إعادة المصادقة.
certificationFromResult(userCredential)	static	يتم استخدام البيانات لاستخراج OAuthCredential الأساسي من UserCredential.

GithubAuthProvider.(أداة الإنشاء)

إنشاء مثيل جديد لفئة GithubAuthProvider

Signature:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_method

اضبط دائمًا على SignInMethod.GITHUB.

Signature:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GitHubAuthProvider.{8/}_ID

اضبط دائمًا على ProviderId.GITHUB.

Signature:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.Credential()

ينشئ بيانات اعتماد لـ GitHub.

Signature:

static credential(accessToken: string): OAuthCredential;

المَعلمات

المعلمة	النوع	الوصف
accessToken	السلسلة	رمز الدخول إلى GitHub.

المرتجعات:

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

GithubAuthProvider.CredentialFromError()

يتم استخدام البيانات لاستخراج OAuthCredential الأساسي من AuthError الذي تم عرضه أثناء تسجيل الدخول أو الربط أو عملية إعادة المصادقة.

Signature:

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

المَعلمات

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

المرتجعات:

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

GithubAuthProvider.CredentialFromResult()

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

Signature:

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

المَعلمات

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

المرتجعات:

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

مثال 1

// Sign in using a redirect.
const provider = new GithubAuthProvider();
// Start a sign in process for an unauthenticated user.
provider.addScope('repo');
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 GitHub Access Token.
  const credential = GithubAuthProvider.credentialFromResult(result);
  const token = credential.accessToken;
}

مثال 2

// Sign in using a popup.
const provider = new GithubAuthProvider();
provider.addScope('repo');
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;