User interface

Учетная запись пользователя.

Подпись:

export interface User extends UserInfo 

Расширяет: UserInfo

Характеристики

Свойство Тип Описание
электронная почтаПодтвержден логическое значение Было ли электронное письмо проверено с помощью sendEmailVerification() и applyActionCode(). .
isAnonymous логическое значение Проходит ли пользователь аутентификацию с использованием ProviderId .АНОНИМНЫЙ провайдер.
метаданные Пользовательские метаданные Дополнительные метаданные о времени создания пользователя и времени входа в систему.
данные поставщика Информация о пользователе [] Дополнительные сведения для каждого поставщика, такие как displayName и информация профиля.
обновитьТокен нить Токен обновления, используемый для повторной аутентификации пользователя. Избегайте использования этого напрямую и вместо этого используйте User.getIdToken() для обновления токена идентификатора.
идентификатор арендатора строка | нулевой Идентификатор клиента пользователя.

Методы

Метод Описание
удалить() Удаляет и выходит из системы пользователя.
getIdToken (forceRefresh) Возвращает веб-токен JSON (JWT), используемый для идентификации пользователя в службе Firebase.
getIdTokenResult (forceRefresh) Возвращает десериализованный веб-токен JSON (JWT), используемый для идентификации пользователя в службе Firebase.
перезагрузить() Обновляет пользователя, если он вошел в систему.
toJSON() Возвращает сериализуемое в формате JSON представление этого объекта.

Пользователь.emailVerified

Было ли электронное письмо проверено с помощью sendEmailVerification() и applyActionCode(). .

Подпись:

readonly emailVerified: boolean;

Пользователь.isAnonymous

Проходит ли пользователь аутентификацию с использованием ProviderId .АНОНИМНЫЙ провайдер.

Подпись:

readonly isAnonymous: boolean;

Пользовательские.метаданные

Дополнительные метаданные о времени создания пользователя и времени входа в систему.

Подпись:

readonly metadata: UserMetadata;

Пользователь.провайдердата

Дополнительные сведения для каждого поставщика, такие как displayName и информация профиля.

Подпись:

readonly providerData: UserInfo[];

Пользователь.refreshToken

Токен обновления, используемый для повторной аутентификации пользователя. Избегайте использования этого напрямую и вместо этого используйте User.getIdToken() для обновления токена идентификатора.

Подпись:

readonly refreshToken: string;

Пользователь.tenantId

Идентификатор клиента пользователя.

Это свойство доступно только для чтения и указывает идентификатор клиента, используемый для входа пользователя. Это значение равно нулю, если пользователь вошел в систему из родительского проекта.

Подпись:

readonly tenantId: string | null;

Пример

// 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'.

Пользователь.удалить()

Удаляет и выходит из системы пользователя.

Этот метод не поддерживается ни для одного пользователя , вошедшего в систему с помощью экземпляров Auth , созданных с помощью FirebaseServerApp. .

Подпись:

delete(): Promise<void>;

Возврат:

Обещание<void>

Пользователь.getIdToken()

Возвращает веб-токен JSON (JWT), используемый для идентификации пользователя в службе Firebase.

Возвращает текущий токен, если срок его действия не истек или срок его действия не истечет в течение следующих пяти минут. В противном случае токен будет обновлен и возвращен новый.

Подпись:

getIdToken(forceRefresh?: boolean): Promise<string>;

Параметры

Параметр Тип Описание
принудительное обновление логическое значение Принудительное обновление независимо от истечения срока действия токена.

Возврат:

Обещание<строка>

Пользователь.getIdTokenResult()

Возвращает десериализованный веб-токен JSON (JWT), используемый для идентификации пользователя в службе Firebase.

Возвращает текущий токен, если срок его действия не истек или срок его действия не истечет в течение следующих пяти минут. В противном случае токен будет обновлен и возвращен новый.

Подпись:

getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;

Параметры

Параметр Тип Описание
принудительное обновление логическое значение Принудительное обновление независимо от истечения срока действия токена.

Возврат:

Обещание < IdTokenResult >

Пользователь.перезагрузка()

Обновляет пользователя, если он вошел в систему.

Подпись:

reload(): Promise<void>;

Возврат:

Обещание<void>

Пользователь.toJSON()

Возвращает сериализуемое в формате JSON представление этого объекта.

Подпись:

toJSON(): object;

Возврат:

объект

Сериализуемое в формате JSON представление этого объекта.