ספק להפקת 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. |
שיטות
שיטה | משנה | תיאור |
---|---|---|
credential (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;
פרמטרים
פָּרָמֶטֶר | סוּג | תיאור |
---|---|---|
UserCredential | תעודת משתמש | תעודת המשתמש. |
החזרות:
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;