GithubAuthProvider class

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。
プロバイダーID	static	「github.com」	常にProviderIdに設定します.GITHUB。

メソッド

方法	修飾子	説明
資格情報(アクセストークン)	static	Github の認証情報を作成します。
credentialFromError(エラー)	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;

パラメーター

パラメータ	タイプ	説明
アクセストークン	弦	Github のアクセス トークン。

戻り値：

OAuth認証情報

GithubAuthProvider.credentialFromError()

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

サイン：

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

パラメーター

パラメータ	タイプ	説明
エラー	FirebaseError

戻り値：

OAuth認証情報|ヌル

GithubAuthProvider.credentialFromResult()

UserCredentialから基礎となる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;