GithubAuthProvider class

ProviderId.GITHUB の OAuthCredential を生成するためのプロバイダ。

GitHub では OAuth 2.0 リダイレクトが必要なため、リダイレクトを直接処理するか、signInWithPopup() ハンドラを使用できます。

署名:

export declare class GithubAuthProvider extends BaseOAuthProvider 

拡張: BaseOAuthProvider

コンストラクタ

コンストラクタ	修飾キー	説明
(structor)()		GithubAuthProvider クラスの新しいインスタンスを作成します。

プロパティ

プロパティ	修飾キー	タイプ	説明
GITHUB_SIGN_IN_Method	static	「github.com」	常に SignInMethod.GITHUB に設定します。
PROVIDER_ID	static	「github.com」	常に ProviderId.GITHUB に設定されます。

メソッド

メソッド	修飾キー	説明
credential(accessToken) を使用します。	static	GitHub の認証情報を作成します。
credentialFromError(error)	static	ログイン、リンク、または再認証の操作中にスローされた AuthError から、基になる OAuthCredential を抽出するために使用されます。
credentialFromResult(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 アクセス トークン。

戻り値:

OAuthCredential

GitHubAuthProvider.credentialFromError()

ログイン、リンク、または再認証の操作中にスローされた AuthError から、基になる OAuthCredential を抽出するために使用されます。

署名:

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

パラメータ

パラメータ	型	説明
エラー	FirebaseError

戻り値:

OAuthCredential |null

GitHubAuthProvider.credentialFromResult()

UserCredential から基になる OAuthCredential を抽出するために使用されます。

署名:

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

パラメータ

パラメータ	型	説明
userCredential	UserCredential（ユーザーの認証情報）	ユーザー認証情報。

戻り値:

OAuthCredential |null

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