UserInfo

interface UserInfo

Known direct subclasses
FirebaseUser

Represents a user's profile information in your Firebase project's user database.


Represents a collection of standard profile information for a user. Can be used to expose profile information returned by an identity provider, such as Google Sign-In or Facebook Login.

Summary

Public functions

String?

Returns the user's display name, if available.

String?

Returns the email address corresponding to the user's account in the specified provider, if available.

String?

Returns the phone number corresponding to the user's account, if available, or null if none exists.

Uri?

Returns a Uri to the user's profile picture, if available.

String

Returns the unique identifier of the provider type that this instance corresponds to.

String

Returns a user identifier as specified by the authentication provider.

Boolean

Returns true if the user's email is verified.

Public functions

getDisplayName

fun getDisplayName(): String?

Returns the user's display name, if available.

getEmail

fun getEmail(): String?

Returns the email address corresponding to the user's account in the specified provider, if available. Some authentication providers, like Twitter, do not contain an email address. Others, like Facebook Login, contain it optionally.

getPhoneNumber

fun getPhoneNumber(): String?

Returns the phone number corresponding to the user's account, if available, or null if none exists.

getPhotoUrl

fun getPhotoUrl(): Uri?

Returns a Uri to the user's profile picture, if available.

getProviderId

fun getProviderId(): String

Returns the unique identifier of the provider type that this instance corresponds to. For example, PROVIDER_ID or PROVIDER_ID.

getUid

fun getUid(): String

Returns a user identifier as specified by the authentication provider. For example, if this object corresponds to a Google user, returns a Google user ID. For phone number accounts, the UID will be the normalized phone number in E.164 format.

isEmailVerified

fun isEmailVerified(): Boolean

Returns true if the user's email is verified.