Interface User

interface User {
    displayName: string | null;
    email: string | null;
    emailVerified: boolean;
    isAnonymous: boolean;
    metadata: UserMetadata;
    multiFactor?: MultiFactor | null;
    phoneNumber: string | null;
    photoURL: string | null;
    providerData: UserInfo[];
    providerId: string;
    refreshToken: string;
    tenantId: string | null;
    uid: string;
    delete(): Promise<void>;
    getIdToken(forceRefresh?: boolean): Promise<string>;
    getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
    reload(): Promise<void>;
    toJSON(): object;
}

Hierarchy (View Summary)

UserInfo
- User

Index

Methods

delete getIdToken getIdTokenResult reload toJSON

Properties

displayName email emailVerified isAnonymous metadata multiFactor? phoneNumber photoURL providerData providerId refreshToken tenantId uid

Methods

delete

delete(): Promise<void>
Returns Promise<void>
- Defined in auth/lib/types/auth.ts:316

getIdToken

getIdToken(forceRefresh?: boolean): Promise<string>
Parameters
- OptionalforceRefresh: boolean
Returns Promise<string>
- Defined in auth/lib/types/auth.ts:317

getIdTokenResult

getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>
Parameters
- OptionalforceRefresh: boolean
Returns Promise<IdTokenResult>
- Defined in auth/lib/types/auth.ts:318

reload

reload(): Promise<void>
Returns Promise<void>
- Defined in auth/lib/types/auth.ts:319

toJSON

toJSON(): object
Returns object
- Defined in auth/lib/types/auth.ts:320

Properties

`Readonly`displayName

displayName: string | null

`Readonly`email

email: string | null

`Readonly`emailVerified

emailVerified: boolean

`Readonly`isAnonymous

isAnonymous: boolean

`Readonly`metadata

metadata: UserMetadata

`Optional` `Readonly`multiFactor

multiFactor?: MultiFactor | null

Present on native user instances returned from auth state listeners.

`Readonly`phoneNumber

phoneNumber: string | null

`Readonly`photoURL

photoURL: string | null

`Readonly`providerData

providerData: UserInfo[]

`Readonly`providerId

providerId: string

`Readonly`refreshToken

refreshToken: string

`Readonly`tenantId

tenantId: string | null

`Readonly`uid

uid: string