User interface

Akun pengguna.

Tanda Tangan:

export interface User extends UserInfo 

Memperluas: UserInfo

Properti

Properti	Jenis	Deskripsi
emailTerverifikasi	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	InfoPengguna[]	Tambahan per penyedia seperti displayName dan informasi profil.
refreshToken	string	Token refresh yang digunakan untuk mengautentikasi ulang pengguna. Hindari menggunakannya secara langsung dan lebih memilih User.getIdToken() untuk memperbarui token ID.
tenantId	rangkaian | null (kosong)	ID tenant pengguna.

Metode

Metode	Deskripsi
delete()	Menghapus dan membuat pengguna logout.
getIdToken(forceRefresh)	Menampilkan Token Web JSON (JWT) yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.
getIdTokenResult(forceRefresh)	Menampilkan Token Web JSON (JWT) deserialisasi yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.
reload()	Memuat ulang pengguna, jika login.
toJSON()	Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini.

Email.penggunaDiverifikasi

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;

Metadata pengguna

Metadata tambahan seputar waktu pembuatan dan login pengguna.

Tanda Tangan:

readonly metadata: UserMetadata;

{i>User.providerData<i}

Tambahan per penyedia seperti displayName dan informasi profil.

Tanda Tangan:

readonly providerData: UserInfo[];

User.refreshToken

Token refresh yang digunakan untuk mengautentikasi ulang pengguna. Hindari menggunakannya secara langsung dan lebih memilih User.getIdToken() untuk memperbarui token ID.

Tanda Tangan:

readonly refreshToken: string;

User.tenantId

ID tenant pengguna.

Properti ini bersifat hanya baca, yang menunjukkan ID tenant yang digunakan untuk membuat pengguna login. Nilai ini akan 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'.

{i>User.delete()<i}

Menghapus dan membuat pengguna logout.

Penting: ini adalah operasi yang sensitif terhadap keamanan dan mengharuskan pengguna untuk sudah login baru-baru ini. Jika persyaratan ini tidak terpenuhi, minta pengguna untuk melakukan autentikasi lagi, lalu panggil salah satu metode autentikasi ulang seperti reauthenticateWithCredential().

Metode ini tidak didukung pada User mana pun yang login oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

delete(): Promise<void>;

Hasil:

Janji<void>

User.getIdToken()

Menampilkan Token Web JSON (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
muat ulang paksa	boolean	Muat ulang paksa terlepas dari masa berlaku token.

Hasil:

Promise<string>

{i>User.getIdTokenResult()<i}

Menampilkan Token Web JSON (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
muat ulang paksa	boolean	Muat ulang paksa terlepas dari masa berlaku token.

Hasil:

Promise<IdTokenResult>

{i>User.reload()<i}

Memuat ulang pengguna, jika login.

Tanda Tangan:

reload(): Promise<void>;

Hasil:

Janji<void>

User.toJSON()

Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini.

Tanda Tangan:

toJSON(): object;

Hasil:

objek

Representasi JSON yang dapat diserialisasi untuk objek ini.