OAuthProvider class

ผู้ให้บริการสำหรับการสร้าง OAuthOAuth ทั่วไป

ลายเซ็น:

export declare class OAuthProvider extends BaseOAuthProvider 

ขยายเวลา: BaseOAuthProvider

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
ข้อมูลเข้าสู่ระบบ(พารามิเตอร์) สร้าง OAuthOAuth จากโทเค็นเพื่อการเข้าถึงหรือโทเค็นรหัสของผู้ให้บริการ OAuth ทั่วไป
credentialFromError(ข้อผิดพลาด) static ใช้เพื่อดึงข้อมูล OAuthCredential ที่สำคัญจาก AuthError ที่ส่งระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือตรวจสอบสิทธิ์อีกครั้ง
credentialFromJSON(json) static สร้าง OAuthCredential จากสตริง JSON หรือออบเจ็กต์ทั่วไป
credentialFromผลลัพธ์(userCredential) static ใช้เพื่อแยก OAuthOAuth ที่สำคัญจาก UserCredential

OAuthProvider.credential()

สร้าง OAuthOAuth จากโทเค็นเพื่อการเข้าถึงหรือโทเค็นรหัสของผู้ให้บริการ OAuth ทั่วไป

ต้องระบุ Nonce ดิบเมื่อมีการระบุโทเค็น ID ที่มีฟิลด์ Nonce แฮช SHA-256 ของค่า Nonce ดิบต้องตรงกับช่อง Nonce ในโทเค็นรหัส

ลายเซ็น:

credential(params: OAuthCredentialOptions): OAuthCredential;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
พารามิเตอร์ OAuthCredentialOptions ออบเจ็กต์ตัวเลือกที่มีโทเค็นรหัส โทเค็นเพื่อการเข้าถึง และ Nonce ดิบหรือสตริงโทเค็นรหัส

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

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

ตัวอย่าง

// `googleUser` from the onsuccess Google Sign In callback.
// Initialize a generate OAuth provider with a `google.com` providerId.
const provider = new OAuthProvider('google.com');
const credential = provider.credential({
  idToken: googleUser.getAuthResponse().id_token,
});
const result = await signInWithCredential(credential);

OAuthProvider.credentialFromError()

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

ลายเซ็น:

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

พารามิเตอร์

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

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

OAuthCredential | ค่าว่าง

OAuthProvider.credentialFromJSON()

สร้าง OAuthCredential จากสตริง JSON หรือออบเจ็กต์ทั่วไป

ลายเซ็น:

static credentialFromJSON(json: object | string): OAuthCredential;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
JSON ออบเจ็กต์ | สตริง ออบเจ็กต์ธรรมดาหรือสตริง JSON

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

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

OAuthProvider.credentialFromResult()

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

ลายเซ็น:

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

พารามิเตอร์

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

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

OAuthCredential | ค่าว่าง

ตัวอย่างที่ 1

// Sign in using a redirect.
const provider = new OAuthProvider('google.com');
// 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 OAuth Access Token for the provider.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}

ตัวอย่างที่ 2

// Sign in using a popup.
const provider = new OAuthProvider('google.com');
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 OAuth Access Token for the provider.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;