ارائه دهنده برای ایجاد OAuthCredential برای ProviderId GITHUB.
GitHub به تغییر مسیر OAuth 2.0 نیاز دارد، بنابراین میتوانید مستقیماً هدایت را مدیریت کنید یا از کنترلکننده signInWithPopup() استفاده کنید:
امضا:
export declare class GithubAuthProvider extends BaseOAuthProvider
گسترش می یابد: BaseOAuthProvider
سازندگان
سازنده | اصلاح کننده ها | شرح |
---|---|---|
(سازنده)() | یک نمونه جدید از کلاس GithubAuthProvider می سازد |
خواص
ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
---|---|---|---|
GITHUB_SIGN_IN_METHOD | static | 'github.com' | همیشه روی SignInMethod تنظیم کنید GITHUB. |
PROVIDER_ID | static | 'github.com' | همیشه روی ProviderId تنظیم شود GITHUB. |
مواد و روش ها
روش | اصلاح کننده ها | شرح |
---|---|---|
اعتبار (accessToken) | static | یک اعتبار برای Github ایجاد می کند. |
credentialFromError (خطا) | static | برای استخراج OAuthCredential زیربنایی از AuthError که در طی یک عملیات ورود به سیستم، پیوند یا احراز هویت مجدد پرتاب شده است استفاده می شود. |
credentialFromResult(userCredential) | static | برای استخراج OAuthCredential زیربنایی از UserCredential استفاده می شود . |
GithubAuthProvider.(سازنده)
یک نمونه جدید از کلاس GithubAuthProvider
می سازد
امضا:
constructor();
GithubAuthProvider.GITHUB_SIGN_IN_METHOD
همیشه روی SignInMethod تنظیم کنید GITHUB.
امضا:
static readonly GITHUB_SIGN_IN_METHOD: 'github.com';
GithubAuthProvider.PROVIDER_ID
همیشه روی ProviderId تنظیم شود GITHUB.
امضا:
static readonly PROVIDER_ID: 'github.com';
GithubAuthProvider.credential()
یک اعتبار برای Github ایجاد می کند.
امضا:
static credential(accessToken: string): OAuthCredential;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
نشانه دسترسی | رشته | رمز دسترسی Github. |
برمی گرداند:
GithubAuthProvider.credentialFromError()
برای استخراج OAuthCredential زیربنایی از AuthError که در طی یک عملیات ورود به سیستم، پیوند یا احراز هویت مجدد پرتاب شده است استفاده می شود.
امضا:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
مولفه های
پارامتر | تایپ کنید | شرح |
---|---|---|
خطا | FirebaseError |
برمی گرداند:
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;