ProviderId के लिए OAuthCredential जनरेट करने वाली कंपनी.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 |
इसका इस्तेमाल, साइन-इन, लिंक या फिर से पुष्टि करने की कार्रवाई के दौरान किए गए AuthError से मौजूदा OAuthCredential को एक्सट्रैक्ट करने के लिए किया जाता है. |
CredentialFromresults(userCredential) | static |
इसका इस्तेमाल, UserCredential से मौजूदा OAuthCredential को एक्सट्रैक्ट करने के लिए किया जाता है. |
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;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
accessToken | स्ट्रिंग | GitHub ऐक्सेस टोकन. |
लौटाए जाने वाले प्रॉडक्ट:
GithubAuthProvider.CredentialFromError()
इसका इस्तेमाल, साइन-इन, लिंक या फिर से पुष्टि करने की कार्रवाई के दौरान किए गए AuthError से मौजूदा OAuthCredential को एक्सट्रैक्ट करने के लिए किया जाता है.
हस्ताक्षर:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
गड़बड़ी | Firebase से जुड़ी गड़बड़ी |
लौटाए जाने वाले प्रॉडक्ट:
OAuthCredential | शून्य
GithubAuthProvider.CredentialFromresults()
इसका इस्तेमाल, UserCredential से मौजूदा OAuthCredential को एक्सट्रैक्ट करने के लिए किया जाता है.
हस्ताक्षर:
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;