GithubAuthProvider class

Anbieter zum Generieren eines OAuthCredential für ProviderId .GITHUB.

GitHub erfordert eine OAuth 2.0-Umleitung, daher können Sie die Umleitung entweder direkt verarbeiten oder den signInWithPopup()- Handler verwenden:

Unterschrift:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Erweitert: BaseOAuthProvider

Konstrukteure

Konstrukteur	Modifikatoren	Beschreibung
(Konstrukteur)()		Konstruiert eine neue Instanz der GithubAuthProvider Klasse

Eigenschaften

Eigentum	Modifikatoren	Typ	Beschreibung
GITHUB_SIGN_IN_METHOD	static	'github.com'	Immer auf SignInMethod setzen .GITHUB.
PROVIDER_ID	static	'github.com'	Immer auf ProviderId setzen .GITHUB.

Methoden

Methode	Modifikatoren	Beschreibung
Anmeldeinformationen(accessToken)	static	Erstellt eine Anmeldeinformation für Github.
credentialFromError(error)	static	Wird verwendet, um das zugrunde liegende OAuthCredential aus einem AuthError zu extrahieren, der während einer Anmelde-, Verknüpfungs- oder Neuauthentifizierungsoperation ausgelöst wurde.
credentialFromResult(userCredential)	static	Wird verwendet, um das zugrunde liegende OAuthCredential aus einem UserCredential zu extrahieren .

GithubAuthProvider.(Konstruktor)

Konstruiert eine neue Instanz der GithubAuthProvider Klasse

Unterschrift:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Immer auf SignInMethod setzen .GITHUB.

Unterschrift:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Immer auf ProviderId setzen .GITHUB.

Unterschrift:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Erstellt eine Anmeldeinformation für Github.

Unterschrift:

static credential(accessToken: string): OAuthCredential;

Parameter

Parameter	Typ	Beschreibung
Zugangstoken	Zeichenfolge	Github-Zugriffstoken.

Kehrt zurück:

OAuthCredential

GithubAuthProvider.credentialFromError()

Wird verwendet, um das zugrunde liegende OAuthCredential aus einem AuthError zu extrahieren, der während einer Anmelde-, Verknüpfungs- oder Neuauthentifizierungsoperation ausgelöst wurde.

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
Fehler	FirebaseError

Kehrt zurück:

OAuthCredential | Null

GithubAuthProvider.credentialFromResult()

Wird verwendet, um das zugrunde liegende OAuthCredential aus einem UserCredential zu extrahieren .

Unterschrift:

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

Parameter

Parameter	Typ	Beschreibung
userCredential	Benutzeranmeldeinformationen	Die Benutzeranmeldeinformationen.

Kehrt zurück:

OAuthCredential | Null

Beispiel 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;
}

Beispiel 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;