प्रदाता आईडी के लिए OAuthCredential उत्पन्न करने के लिए प्रदाता .गीथूब।
GitHub को OAuth 2.0 रीडायरेक्ट की आवश्यकता है, ताकि आप या तो सीधे रीडायरेक्ट को संभाल सकें, या साइनइनविथपॉपअप() हैंडलर का उपयोग कर सकें:
हस्ताक्षर:
export declare class GithubAuthProvider extends BaseOAuthProvider
विस्तार: BaseOAuthProvider
कंस्ट्रक्टर्स
निर्माता | संशोधक | विवरण |
---|---|---|
(निर्माता)() | GithubAuthProvider वर्ग का एक नया उदाहरण बनाता है |
गुण
संपत्ति | संशोधक | प्रकार | विवरण |
---|---|---|---|
GITHUB_SIGN_IN_METHOD | static | 'github.com' | हमेशा साइनइनमेथड पर सेट करें .गीथूब। |
प्रदाता_आईडी | static | 'github.com' | हमेशा प्रदाताआईडी पर सेट करें .गीथूब। |
तरीकों
तरीका | संशोधक | विवरण |
---|---|---|
क्रेडेंशियल(एक्सेसटोकन) | static | Github के लिए एक क्रेडेंशियल बनाता है। |
क्रेडेंशियलफ्रॉमएरर(त्रुटि) | static | AuthError से अंतर्निहित OAuthCredential को निकालने के लिए उपयोग किया जाता है जिसे साइन-इन, लिंक या पुन:प्रमाणित ऑपरेशन के दौरान फेंक दिया गया था। |
credentialFromResult(userCredential) | static | उपयोगकर्ता क्रेडेंशियल से अंतर्निहित OAuthCredential निकालने के लिए उपयोग किया जाता है . |
GithubAuthProvider.(निर्माता)
GithubAuthProvider
वर्ग का एक नया उदाहरण बनाता है
हस्ताक्षर:
constructor();
GithubAuthProvider.GITHUB_SIGN_IN_METHOD
हमेशा साइनइनमेथड पर सेट करें .गीथूब।
हस्ताक्षर:
static readonly GITHUB_SIGN_IN_METHOD: 'github.com';
GithubAuthProvider.PROVIDER_ID
हमेशा प्रदाताआईडी पर सेट करें .गीथूब।
हस्ताक्षर:
static readonly PROVIDER_ID: 'github.com';
GithubAuthProvider.credential()
Github के लिए एक क्रेडेंशियल बनाता है।
हस्ताक्षर:
static credential(accessToken: string): OAuthCredential;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
एक्सेस टोकन | डोरी | जीथब एक्सेस टोकन। |
रिटर्न:
GithubAuthProvider.credentialFromError()
AuthError से अंतर्निहित OAuthCredential को निकालने के लिए उपयोग किया जाता है जिसे साइन-इन, लिंक या पुन:प्रमाणित ऑपरेशन के दौरान फेंक दिया गया था।
हस्ताक्षर:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
गलती | फायरबेसत्रुटि |
रिटर्न:
OAuthक्रेडेंशियल | व्यर्थ
GithubAuthProvider.credentialFromResult()
उपयोगकर्ता क्रेडेंशियल से अंतर्निहित OAuthCredential निकालने के लिए उपयोग किया जाता है .
हस्ताक्षर:
static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
उपयोगकर्ता क्रेडेंशियल | उपयोगकर्ता क्रेडेंशियल | उपयोगकर्ता क्रेडेंशियल. |
रिटर्न:
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;