auth namespace

ฟังก์ชั่น

การทำงาน คำอธิบาย
ผู้ใช้ (ตัวเลือกผู้ใช้) จัดการเหตุการณ์ที่เกี่ยวข้องกับเหตุการณ์ผู้ใช้ Firebase Auth
userRecordConstructor (wireData) ฟังก์ชันตัวช่วยที่สร้างคลาส UserRecord จากข้อมูลที่ส่งผ่านสาย

ชั้นเรียน

ระดับ คำอธิบาย
HttpsError ข้อผิดพลาดที่ชัดเจนที่สามารถส่งจากตัวจัดการเพื่อส่งข้อผิดพลาดไปยังไคลเอนต์ที่เรียกว่าฟังก์ชัน
UserBuilder ตัวสร้างใช้เพื่อสร้างฟังก์ชันสำหรับเหตุการณ์วงจรการใช้งานผู้ใช้ Firebase Auth
UserRecordMetadata คลาสตัวช่วยในการสร้างข้อมูลเมตาของผู้ใช้ในวัตถุ UserRecord

อินเทอร์เฟซ

อินเตอร์เฟซ คำอธิบาย
ตัวเลือกผู้ใช้ ตัวเลือกสำหรับฟังก์ชันการบล็อกการตรวจสอบสิทธิ์

พิมพ์นามแฝง

พิมพ์นามแฝง คำอธิบาย
ข้อมูลผู้ใช้ UserInfo ที่เป็นส่วนหนึ่งของ UserRecord
บันทึกผู้ใช้ UserRecord ที่ส่งไปยัง Cloud Functions เป็น UserRecord เดียวกันกับที่ Firebase Admin SDK ส่งคืน

รับรองความถูกต้อง.ผู้ใช้()

จัดการเหตุการณ์ที่เกี่ยวข้องกับเหตุการณ์ผู้ใช้ Firebase Auth

ลายเซ็น:

export declare function user(userOptions?: UserOptions): UserBuilder;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
ตัวเลือกผู้ใช้ ตัวเลือกผู้ใช้ ตัวเลือกระดับทรัพยากร

ผลตอบแทน:

UserBuilder

UserBuilder - ตัวสร้างที่ใช้เพื่อสร้างฟังก์ชันสำหรับเหตุการณ์วงจรการใช้งานผู้ใช้ Firebase Auth

auth.userRecordConstructor ()

ฟังก์ชันตัวช่วยที่สร้างคลาส UserRecord จากข้อมูลที่ส่งผ่านสาย

ลายเซ็น:

export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;

พารามิเตอร์

พารามิเตอร์ พิมพ์ คำอธิบาย
wireData บันทึก<สตริง, ไม่ทราบ> ข้อมูลที่ส่งผ่านสาย

ผลตอบแทน:

บันทึกผู้ใช้

อินสแตนซ์ของ UserRecord ที่มีฟังก์ชัน toJSON ที่ถูกต้อง

รับรองความถูกต้อง UserInfo

UserInfo ที่เป็นส่วนหนึ่งของ UserRecord .

ลายเซ็น:

export type UserInfo = auth.UserInfo;

รับรองความถูกต้อง UserRecord

UserRecord ที่ส่งไปยัง Cloud Functions เป็น UserRecord เดียวกันกับที่ Firebase Admin SDK ส่งคืน

ลายเซ็น:

export type UserRecord = auth.UserRecord;