ผู้ให้บริการสำหรับการสร้าง OAuthCredential สำหรับ ProviderId .GITHUB
GitHub ต้องมีการเปลี่ยนเส้นทาง OAuth 2.0 ดังนั้นคุณจึงสามารถจัดการการเปลี่ยนเส้นทางได้โดยตรง หรือใช้ตัวจัดการ signInWithPopup()
ลายเซ็น:
export declare class GithubAuthProvider extends BaseOAuthProvider
ขยาย: BaseOAuthProvider
คอนสตรัคเตอร์
ตัวสร้าง | ตัวดัดแปลง | คำอธิบาย |
---|---|---|
(ตัวสร้าง)() | สร้างอินสแตนซ์ใหม่ของคลาส GithubAuthProvider |
คุณสมบัติ
คุณสมบัติ | ตัวดัดแปลง | พิมพ์ | คำอธิบาย |
---|---|---|---|
GITHUB_SIGN_IN_METHOD | static | 'github.com' | ตั้งค่าเป็น SignInMethod เสมอ .GITHUB |
PROVIDER_ID | static | 'github.com' | ตั้งค่าเป็น ProviderId เสมอ .GITHUB |
วิธีการ
วิธี | ตัวดัดแปลง | คำอธิบาย |
---|---|---|
ข้อมูลประจำตัว (accessToken) | static | สร้างข้อมูลรับรองสำหรับ Github |
ข้อมูลรับรองจากข้อผิดพลาด (ข้อผิดพลาด) | static | ใช้เพื่อแยก OAuthCredential พื้นฐานจาก AuthError ซึ่งเกิดขึ้นระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือการตรวจสอบสิทธิ์อีกครั้ง |
หนังสือรับรองจากผลลัพธ์ (ข้อมูลรับรองผู้ใช้) | static | ใช้เพื่อแยก OAuthCredential พื้นฐานจาก UserCredential . |
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()
ใช้เพื่อแยก OAuthCredential พื้นฐานจาก AuthError ซึ่งเกิดขึ้นระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือการตรวจสอบสิทธิ์อีกครั้ง
ลายเซ็น:
static credentialFromError(error: FirebaseError): OAuthCredential | null;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ข้อผิดพลาด | ข้อผิดพลาดของ Firebase |
ผลตอบแทน:
ข้อมูลรับรอง OAuth | โมฆะ
GithubAuthProvider.credentialFromResult()
ใช้เพื่อแยก OAuthCredential พื้นฐานจาก UserCredential .
ลายเซ็น:
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;