GithubAuthProvider class

ผู้ให้บริการสำหรับสร้าง OAuthOAuth สำหรับ 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
credentialFromError(ข้อผิดพลาด)	static	ใช้เพื่อดึงข้อมูล OAuthCredential ที่สำคัญจาก AuthError ที่ส่งระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือตรวจสอบสิทธิ์อีกครั้ง
credentialFromผลลัพธ์(userCredential)	static	ใช้เพื่อแยก OAuthOAuth ที่สำคัญจาก 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;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
accessToken	สตริง	โทเค็นเพื่อการเข้าถึง GitHub

การคืนสินค้า:

ข้อมูลประจำตัว OAuth

GitHubAuthProvider.credentialFromError()

ใช้เพื่อดึงข้อมูล OAuthCredential ที่สำคัญจาก AuthError ที่ส่งระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือตรวจสอบสิทธิ์อีกครั้ง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ข้อผิดพลาด	ข้อผิดพลาด Firebase

การคืนสินค้า:

OAuthCredential | ค่าว่าง

GitHubAuthProvider.credentialFromผลลัพธ์()

ใช้เพื่อแยก OAuthOAuth ที่สำคัญจาก UserCredential

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ข้อมูลเข้าสู่ระบบของผู้ใช้	รหัสผู้ใช้	ข้อมูลเข้าสู่ระบบของผู้ใช้

การคืนสินค้า:

OAuthCredential | ค่าว่าง

ตัวอย่างที่ 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;