Namespace userManagement

A namespace containing tools for managing the current user.

namespace

Index

Namespaces

dangerous

Functions

Functions

Const getCreationTime

getCreationTime(): string

Gets the creation date of the logged in users account.

Returns string

Const getDisplayName

getDisplayName(): string

Gets the display name of the current user.

Returns string

Const getEmail

getEmail(): string

Gets the users email address.

Returns string

Const getLastLoginTime

getLastLoginTime(): string

Gets the last login date of the logged in users account.

Returns string

Const getPhoneNumber

getPhoneNumber(): string

Gets the current users phone number.

Returns string

Const getPhotoURL

getPhotoURL(): string

Gets the users profile picture URL.

Returns string

Const getRefreshToken

getRefreshToken(): string

Gets the refresh token. For advanced usage only.

Returns string

Const getTenantID

getTenantID(): string

Gets the tenant ID. For advanced usage only.

Returns string

Const getUID

getUID(): string

Gets the current users Unique IDentifier.

Returns string

Const isEmailVerified

isEmailVerified(): boolean

Verifies if the current users email is verified.

Returns boolean

Const sendVerificationEmail

sendVerificationEmail(): Promise<void> | ""

Send an email to the users email address to verify it.

note
Even though this function is redundant, we keep it for consistency.

see
currentUser.sendEmailVerification

Returns Promise<void> | ""

Const setDisplayName

setDisplayName(newDisplayName: string): Promise<void>

Changes the display name of an user.

Parameters
- newDisplayName: string
Returns Promise<void>

Const setPhotoURL

setPhotoURL(newPhotoURL: string): Promise<void>

Changes the URL to the profile picture of the user.

Parameters
- newPhotoURL: string
Returns Promise<void>

Generated using TypeDoc