GoogleAuthProvider class

用於為ProviderId產生OAuthCredential 的提供者.GOOGLE.

簽名:

export declare class GoogleAuthProvider extends BaseOAuthProvider 

擴充: BaseOAuthProvider

建構函數

建構函數修飾符描述
(構造函數)()建構GoogleAuthProvider類別的新實例

特性

財產修飾符類型描述
GOOGLE_SIGN_IN_METHOD static 'google.com'始終設定為SignInMethod .GOOGLE.
提供者_ID static 'google.com'始終設定為ProviderId .GOOGLE.

方法

方法修飾符描述
憑證(idToken,accessToken) static為 Google 建立憑證。至少需要 ID 令牌和存取令牌之一。
憑證來自錯誤(錯誤) static用於從登入、連結或重新驗證作業期間引發的AuthError中提取基礎OAuthCredential
憑證來自結果(使用者憑證) static用於從UserCredential中提取底層OAuthCredential

GoogleAuthProvider.(建構子)

建構GoogleAuthProvider類別的新實例

簽名:

constructor();

GoogleAuthProvider.GOOGLE_SIGN_IN_METHOD

始終設定為SignInMethod .GOOGLE.

簽名:

static readonly GOOGLE_SIGN_IN_METHOD: 'google.com';

GoogleAuthProvider.PROVIDER_ID

始終設定為ProviderId .GOOGLE.

簽名:

static readonly PROVIDER_ID: 'google.com';

GoogleAuthProvider.credential()

為 Google 建立憑證。至少需要 ID 令牌和存取令牌之一。

簽名:

static credential(idToken?: string | null, accessToken?: string | null): OAuthCredential;

參數

範圍類型描述
id令牌字串|無效的Google ID 令牌。
訪問令牌字串|無效的谷歌訪問令牌。

返回:

OAuth憑證

例子

// \`googleUser\` from the onsuccess Google Sign In callback.
const credential = GoogleAuthProvider.credential(googleUser.getAuthResponse().id_token);
const result = await signInWithCredential(credential);

GoogleAuthProvider.credentialFromError()

用於從登入、連結或重新驗證作業期間引發的AuthError中提取基礎OAuthCredential

簽名:

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

參數

範圍類型描述
錯誤Firebase錯誤

返回:

OAuth 憑證|無效的

GoogleAuthProvider.credentialFromResult()

用於從UserCredential中提取底層OAuthCredential

簽名:

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

參數

範圍類型描述
使用者憑證使用者憑證用戶憑證。

返回:

OAuth 憑證|無效的

實施例1

// Sign in using a redirect.
const provider = new GoogleAuthProvider();
// Start a sign in process for an unauthenticated user.
provider.addScope('profile');
provider.addScope('email');
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 Google Access Token.
  const credential = GoogleAuthProvider.credentialFromResult(result);
  const token = credential.accessToken;
}

實施例2

// Sign in using a popup.
const provider = new GoogleAuthProvider();
provider.addScope('profile');
provider.addScope('email');
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Google Access Token.
const credential = GoogleAuthProvider.credentialFromResult(result);
const token = credential.accessToken;