GithubAuthProvider class

Nhà cung cấp để tạo OAuthCredential cho ProviderId .GITHUB.

GitHub yêu cầu chuyển hướng OAuth 2.0, vì vậy bạn có thể xử lý chuyển hướng trực tiếp hoặc sử dụng trình xử lý signInWithPopup() :

Chữ ký:

export declare class GithubAuthProvider extends BaseOAuthProvider 

Mở rộng: BaseOAuthProvider

nhà xây dựng

Người xây dựng sửa đổi Sự miêu tả
(người xây dựng)() Xây dựng một phiên bản mới của lớp GithubAuthProvider

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
GITHUB_SIGN_IN_METHOD static 'github.com' Luôn đặt thành SignInMethod .GITHUB.
PROVIDER_ID static 'github.com' Luôn đặt thành ProviderId .GITHUB.

phương pháp

Phương pháp sửa đổi Sự miêu tả
thông tin xác thực (accessToken) static Tạo thông tin xác thực cho Github.
thông tin xác thựcFromError(lỗi) static Được sử dụng để trích xuất OAuthCredential cơ bản từ AuthError được đưa ra trong quá trình đăng nhập, liên kết hoặc xác thực lại.
thông tin xác thựcFromResult(userCredential) static Được sử dụng để trích xuất OAuthCredential cơ bản từ UserCredential .

GithubAuthProvider.(hàm tạo)

Xây dựng một phiên bản mới của lớp GithubAuthProvider

Chữ ký:

constructor();

GithubAuthProvider.GITHUB_SIGN_IN_METHOD

Luôn đặt thành SignInMethod .GITHUB.

Chữ ký:

static readonly GITHUB_SIGN_IN_METHOD: 'github.com';

GithubAuthProvider.PROVIDER_ID

Luôn đặt thành ProviderId .GITHUB.

Chữ ký:

static readonly PROVIDER_ID: 'github.com';

GithubAuthProvider.credential()

Tạo thông tin xác thực cho Github.

Chữ ký:

static credential(accessToken: string): OAuthCredential;

Thông số

Tham số Kiểu Sự miêu tả
truy cập thẻ sợi dây Mã thông báo truy cập Github.

Trả về:

Thông tin xác thực OAuth

GithubAuthProvider.credentialFromError()

Được sử dụng để trích xuất OAuthCredential cơ bản từ AuthError được đưa ra trong quá trình đăng nhập, liên kết hoặc xác thực lại.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
lỗi FirebaseLỗi

Trả về:

Thông tin xác thực OAuth | vô giá trị

GithubAuthProvider.credentialFromResult()

Được sử dụng để trích xuất OAuthCredential cơ bản từ UserCredential .

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
thông tin người dùng Thông tin người dùng Thông tin xác thực của người dùng.

Trả về:

Thông tin xác thực OAuth | vô giá trị

ví dụ 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;
}

Ví dụ 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;