Un account utente.
Firma:
export interface User extends UserInfo
Estensioni:UserInfo
Proprietà
| Proprietà | Tipo | Descrizione |
|---|---|---|
| emailVerified | boolean | Se l'email è stata verificata con sendEmailVerification() e applyActionCode(). |
| isAnonymous | boolean | Indica se l'utente viene autenticato utilizzando il provider ProviderId.ANONYMOUS. |
| metadati | UserMetadata | Metadati aggiuntivi sulla creazione degli utenti e sui tempi di accesso. |
| providerData | UserInfo[] | Contenuto aggiuntivo per provider, ad esempio displayName e informazioni del profilo. |
| refreshToken | stringa | Token di aggiornamento utilizzato per riautenticare l'utente. Evita di usarla direttamente e preferisci che User.getIdToken() aggiorni il token ID. |
| tenantId | stringa | null | L'ID tenant dell'utente. |
Metodi
| Metodo | Descrizione |
|---|---|
| delete() | Elimina l'utente ed esce dall'account. |
| getIdToken(forceRefresh) | Restituisce un token JWT (JSON Web Token) utilizzato per identificare l'utente in un servizio Firebase. |
| getIdTokenResult(forceRefresh) | Restituisce un token JWT (JSON Web Token) deserializzato per identificare l'utente in un servizio Firebase. |
| reload() | Aggiorna l'utente, se ha eseguito l'accesso. |
| toJSON() | Restituisce una rappresentazione seriale JSON dell'oggetto. |
User.emailVerified
Se l'email è stata verificata con sendEmailVerification() e applyActionCode().
Firma:
readonly emailVerified: boolean;
User.isAnonymous
Indica se l'utente viene autenticato utilizzando il provider ProviderId.ANONYMOUS.
Firma:
readonly isAnonymous: boolean;
User.metadata
Metadati aggiuntivi sulla creazione degli utenti e sui tempi di accesso.
Firma:
readonly metadata: UserMetadata;
User.providerData
Contenuto aggiuntivo per provider, ad esempio displayName e informazioni del profilo.
Firma:
readonly providerData: UserInfo[];
User.refreshToken
Token di aggiornamento utilizzato per riautenticare l'utente. Evita di usarla direttamente e preferisci che User.getIdToken() aggiorni il token ID.
Firma:
readonly refreshToken: string;
User.tenantId
L'ID tenant dell'utente.
Questa è una proprietà di sola lettura che indica l'ID tenant utilizzato per accedere all'utente. Questo valore è nullo se l'utente ha eseguito l'accesso dal progetto principale.
Firma:
readonly tenantId: string | null;
Esempio
// 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()
Elimina l'utente ed esce dall'account.
Questo metodo non è supportato per gli utenti User a cui è stato eseguito l'accesso tramite le istanze Auth create con FirebaseServerApp.
Firma:
delete(): Promise<void>;
Resi:
Promise<void>
User.getIdToken()
Restituisce un token JWT (JSON Web Token) utilizzato per identificare l'utente in un servizio Firebase.
Restituisce il token corrente se non è scaduto o se non scade nei cinque minuti successivi. In caso contrario, il token verrà aggiornato e ne verrà restituito uno nuovo.
Firma:
getIdToken(forceRefresh?: boolean): Promise<string>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| forceRefresh | boolean | Forza l'aggiornamento indipendentemente dalla scadenza del token. |
Resi:
Promessa<string>
User.getIdTokenResult()
Restituisce un token JWT (JSON Web Token) deserializzato per identificare l'utente in un servizio Firebase.
Restituisce il token corrente se non è scaduto o se non scade nei cinque minuti successivi. In caso contrario, il token verrà aggiornato e ne verrà restituito uno nuovo.
Firma:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| forceRefresh | boolean | Forza l'aggiornamento indipendentemente dalla scadenza del token. |
Resi:
Promise<IdTokenResult>
User.reload()
Aggiorna l'utente, se ha eseguito l'accesso.
Firma:
reload(): Promise<void>;
Resi:
Promise<void>
User.toJSON()
Restituisce una rappresentazione seriale JSON dell'oggetto.
Firma:
toJSON(): object;
Resi:
oggetto
Una rappresentazione seriale JSON dell'oggetto.