Akun pengguna.
Tanda Tangan:
export interface User extends UserInfo
Memperluas: UserInfo
Properti
| Properti | Jenis | Deskripsi |
|---|---|---|
| emailVerified | boolean | Apakah email telah diverifikasi dengan sendEmailVerification() dan applyActionCode(). |
| isAnonymous | boolean | Apakah pengguna diautentikasi menggunakan penyedia ProviderId.ANONYMOUS. |
| metadata | UserMetadata | Metadata tambahan seputar waktu pembuatan dan login pengguna. |
| providerData | UserInfo[] | Tambahan per penyedia seperti displayName dan informasi profil. |
| refreshToken | string | Token refresh yang digunakan untuk mengautentikasi ulang pengguna. Hindari penggunaannya secara langsung dan pilih User.getIdToken() untuk memperbarui token ID. |
| tenantId | string | null | ID tenant pengguna. |
Metode
| Metode | Deskripsi |
|---|---|
| delete() | Menghapus dan membuat pengguna logout. |
| getIdToken(forceRefresh) | Menampilkan JSON Web Token (JWT) yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase. |
| getIdTokenResult(forceRefresh) | Menampilkan JSON Web Token (JWT) deserialisasi yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase. |
| reload() | Memuat ulang pengguna, jika login. |
| toJSON() | Menampilkan representasi objek yang dapat diserialisasi JSON. |
User.emailVerified
Apakah email telah diverifikasi dengan sendEmailVerification() dan applyActionCode().
Tanda Tangan:
readonly emailVerified: boolean;
User.isAnonymous
Apakah pengguna diautentikasi menggunakan penyedia ProviderId.ANONYMOUS.
Tanda Tangan:
readonly isAnonymous: boolean;
User.metadata
Metadata tambahan seputar waktu pembuatan dan login pengguna.
Tanda Tangan:
readonly metadata: UserMetadata;
User.providerData
Tambahan per penyedia seperti displayName dan informasi profil.
Tanda Tangan:
readonly providerData: UserInfo[];
User.refreshToken
Token refresh yang digunakan untuk mengautentikasi ulang pengguna. Hindari penggunaannya secara langsung dan pilih User.getIdToken() untuk memperbarui token ID.
Tanda Tangan:
readonly refreshToken: string;
User.tenantId
ID tenant pengguna.
Properti ini adalah properti hanya baca, yang menunjukkan ID tenant yang digunakan untuk membuat pengguna login. Nilai ini null jika pengguna login dari project induk.
Tanda Tangan:
readonly tenantId: string | null;
Contoh
// 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()
Menghapus dan membuat pengguna logout.
Metode ini tidak didukung di User yang login dengan instance Auth yang dibuat dengan FirebaseServerApp.
Tanda Tangan:
delete(): Promise<void>;
Hasil:
Promise<void>
User.getIdToken()
Menampilkan JSON Web Token (JWT) yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.
Menampilkan token saat ini jika belum habis masa berlakunya atau jika tidak akan habis masa berlakunya dalam lima menit ke depan. Jika tidak, tindakan ini akan memperbarui token dan menampilkan token baru.
Tanda Tangan:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| forceRefresh | boolean | Memaksa refresh terlepas dari masa berlaku tokennya. |
Hasil:
Promise<string>
User.getIdTokenResult()
Menampilkan JSON Web Token (JWT) deserialisasi yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.
Menampilkan token saat ini jika belum habis masa berlakunya atau jika tidak akan habis masa berlakunya dalam lima menit ke depan. Jika tidak, tindakan ini akan memperbarui token dan menampilkan token baru.
Tanda Tangan:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| forceRefresh | boolean | Memaksa refresh terlepas dari masa berlaku tokennya. |
Hasil:
Promise<IdTokenResult>
User.reload()
Memuat ulang pengguna, jika login.
Tanda Tangan:
reload(): Promise<void>;
Hasil:
Promise<void>
User.toJSON()
Menampilkan representasi objek yang dapat diserialisasi JSON.
Tanda Tangan:
toJSON(): object;
Hasil:
objek
Representasi objek ini yang dapat diserialisasi JSON.