用於為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。 |
方法
方法 | 修飾符 | 描述 |
---|---|---|
憑證(accessToken) | static | 為 Github 建立憑證。 |
憑證來自錯誤(錯誤) | static | 用於從登入、連結或重新驗證作業期間引發的AuthError中提取基礎OAuthCredential 。 |
憑證來自結果(使用者憑證) | 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 存取令牌。 |
返回:
GithubAuthProvider.credentialFromError()
用於從登入、連結或重新驗證作業期間引發的AuthError中提取基礎OAuthCredential 。
簽名:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
參數
範圍 | 類型 | 描述 |
---|---|---|
錯誤 | Firebase錯誤 |
返回:
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;