บัญชีผู้ใช้
ลายเซ็น:
export interface User extends UserInfo
ขยาย: UserInfo
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | ประเภท | คำอธิบาย |
|---|---|---|
| emailVerified | boolean | ดูว่าอีเมลได้รับการยืนยันด้วย sendEmailVerification() และ applyActionCode() หรือไม่ |
| isAnonymous | boolean | ดูว่าผู้ใช้ผ่านการตรวจสอบสิทธิ์โดยใช้ผู้ให้บริการ ProviderId.ANONYMOUS หรือไม่ |
| ข้อมูลเมตา | UserMetadata | ข้อมูลเมตาเพิ่มเติมเกี่ยวกับการสร้างผู้ใช้และเวลาที่ลงชื่อเข้าใช้ |
| providerData | UserInfo[] | ข้อมูลเพิ่มเติมตามผู้ให้บริการ เช่น displayName และข้อมูลโปรไฟล์ |
| refreshToken | string | โทเค็นการรีเฟรชที่ใช้เพื่อตรวจสอบสิทธิ์ผู้ใช้อีกครั้ง หลีกเลี่ยงการใช้วิธีนี้โดยตรงและต้องการให้ User.getIdToken() รีเฟรชโทเค็นรหัสแทน |
| tenantId | สตริง | ค่าว่าง | รหัสกลุ่มผู้ใช้ของผู้ใช้ |
วิธีการ
| วิธีการ | คำอธิบาย |
|---|---|
| delete() | ลบและนำผู้ใช้ออกจากระบบ |
| getIdToken(forceRefresh) | แสดงผล JSON Web Token (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase |
| getIdTokenResult(forceRefresh) | แสดงผลโทเค็นเว็บ JSON แบบดีซีเรียลไลซ์ (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase |
| reload() | รีเฟรชผู้ใช้หากลงชื่อเข้าใช้อยู่ |
| toJSON() | แสดงการแทนรูปแบบ JSON ของออบเจ็กต์นี้ |
User.emailVerified
ดูว่าอีเมลได้รับการยืนยันด้วย sendEmailVerification() และ applyActionCode() หรือไม่
ลายเซ็น:
readonly emailVerified: boolean;
User.isAnonymous
ดูว่าผู้ใช้ผ่านการตรวจสอบสิทธิ์โดยใช้ผู้ให้บริการ ProviderId.ANONYMOUS หรือไม่
ลายเซ็น:
readonly isAnonymous: boolean;
User.metadata
ข้อมูลเมตาเพิ่มเติมเกี่ยวกับการสร้างผู้ใช้และเวลาที่ลงชื่อเข้าใช้
ลายเซ็น:
readonly metadata: UserMetadata;
User.providerData
ข้อมูลเพิ่มเติมตามผู้ให้บริการ เช่น displayName และข้อมูลโปรไฟล์
ลายเซ็น:
readonly providerData: UserInfo[];
User.refreshToken
โทเค็นการรีเฟรชที่ใช้เพื่อตรวจสอบสิทธิ์ผู้ใช้อีกครั้ง หลีกเลี่ยงการใช้วิธีนี้โดยตรงและต้องการให้ User.getIdToken() รีเฟรชโทเค็นรหัสแทน
ลายเซ็น:
readonly refreshToken: string;
User.tenantId
รหัสกลุ่มผู้ใช้ของผู้ใช้
นี่คือพร็อพเพอร์ตี้แบบอ่านอย่างเดียวซึ่งระบุรหัสผู้เช่าที่ใช้ลงชื่อเข้าใช้ผู้ใช้ ค่านี้จะว่างเปล่าหากผู้ใช้ลงชื่อเข้าใช้จากโปรเจ็กต์หลัก
ลายเซ็น:
readonly tenantId: string | null;
ตัวอย่าง
// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';
// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.
User.delete()
ลบและนำผู้ใช้ออกจากระบบ
ระบบไม่รองรับวิธีนี้ในผู้ใช้ที่ลงชื่อเข้าใช้โดยอินสแตนซ์ Auth ซึ่งสร้างขึ้นด้วย FirebaseServerApp
ลายเซ็น:
delete(): Promise<void>;
การคืนสินค้า:
Promise<void>
User.getIdToken()
แสดงผล JSON Web Token (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase
แสดงผลโทเค็นปัจจุบันหากยังไม่หมดอายุหรือไม่หมดอายุในอีก 5 นาทีข้างหน้า ไม่เช่นนั้น การดำเนินการนี้จะรีเฟรชโทเค็นและแสดงผลโทเค็นใหม่
ลายเซ็น:
getIdToken(forceRefresh?: boolean): Promise<string>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| forceRefresh | boolean | บังคับรีเฟรชไม่ว่าโทเค็นจะหมดอายุหรือไม่ก็ตาม |
การคืนสินค้า:
คำสัญญา<string>
User.getIdTokenResult()
แสดงผลโทเค็นเว็บ JSON แบบดีซีเรียลไลซ์ (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase
แสดงผลโทเค็นปัจจุบันหากยังไม่หมดอายุหรือไม่หมดอายุในอีก 5 นาทีข้างหน้า ไม่เช่นนั้น การดำเนินการนี้จะรีเฟรชโทเค็นและแสดงผลโทเค็นใหม่
ลายเซ็น:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| forceRefresh | boolean | บังคับรีเฟรชไม่ว่าโทเค็นจะหมดอายุหรือไม่ก็ตาม |
การคืนสินค้า:
Promise<IdTokenResult>
User.reload()
รีเฟรชผู้ใช้หากลงชื่อเข้าใช้อยู่
ลายเซ็น:
reload(): Promise<void>;
การคืนสินค้า:
Promise<void>
User.toJSON()
แสดงการแทนรูปแบบ JSON ของออบเจ็กต์นี้
ลายเซ็น:
toJSON(): object;
การคืนสินค้า:
ออบเจ็กต์
การแทนรูปแบบ JSON ของออบเจ็กต์นี้