GithubAuthProvider class

موفر لإنشاء OAuthCredential لـ ProviderId .جيثب.

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

إمضاء:

export declare class GithubAuthProvider extends BaseOAuthProvider 

يمتد: BaseOAuthProvider

البنائين

ملكيات

طُرق

GithubAuthProvider.(المنشئ)

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

إمضاء:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

اضبط دائمًا على SignInMethod .جيثب.

إمضاء:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

اضبط دائمًا على ProviderId .جيثب.

إمضاء:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

ينشئ بيانات اعتماد لجيثب.

إمضاء:

static credential(accessToken: string): OAuthCredential;

حدود

عائدات:

OAuthCredential

GithubAuthProvider.credentialFromError()

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

إمضاء:

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

حدود

عائدات:

OAuthCredential | باطل

GithubAuthProvider.credentialFromResult()

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

إمضاء:

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

حدود

عائدات:

OAuthCredential | باطل

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