Nhà cung cấp để tạo OAuthCredential cho ProviderId.GITHUB.
GitHub yêu cầu lệnh chuyển hướng OAuth 2.0, vì vậy, bạn có thể trực tiếp xử lý lệnh chuyển hướng hoặc sử dụng trình xử lý signInWithPopup():
Chữ ký:
export declare class GithubAuthProvider extends BaseOAuthProvider
Mở rộng: BaseOAuthProvider
Công ty sản xuất
Công ty sản xuất | Công cụ sửa đổi | Mô tả |
---|---|---|
(hàm khởi tạo)() | Tạo một thực thể mới của lớp GithubAuthProvider |
Thuộc tính
Tài sản | Công cụ sửa đổi | Loại | Mô 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 thức
Phương thức | Công cụ sửa đổi | Mô tả |
---|---|---|
thông tin xác thực(accessToken) | static |
Tạo thông tin xác thực cho GitHub. |
credentialFromError(lỗi) | static |
Dùng để trích xuất OAuthCredential cơ bản từ AuthError được gửi trong thao tác đăng nhập, liên kết hoặc xác thực lại. |
credentialFromResult(userCredential) | static |
Dùng để trích xuất OAuthCredential cơ bản từ UserCredential. |
GitHubAuthProvider.(hàm khởi tạo)
Tạo một thực thể 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ố
Thông số | Loại | Mô tả |
---|---|---|
accessToken | chuỗi | Mã truy cập GitHub. |
Trường hợp trả lại hàng:
GitHubAuthProvider.credentialFromError()
Dùng để trích xuất OAuthCredential cơ bản từ AuthError được gửi trong thao tác đă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ố
Thông số | Loại | Mô tả |
---|---|---|
error | Lỗi Firebase |
Trường hợp trả lại hàng:
Thông tin đăng nhập OAuth | rỗng
GitHubAuthProvider.credentialFromResult()
Dùng để trích xuất OAuthCredential cơ bản từ UserCredential.
Chữ ký:
static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
thông tin xác thực người dùng | Thông tin đăng nhập của người dùng | Thông tin đăng nhập của người dùng. |
Trường hợp trả lại hàng:
Thông tin đăng nhập OAuth | rỗng
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;