Auth interface

Интерфейс, представляющий службу Firebase Auth.

См. «Аутентификация Firebase» для получения полного руководства по использованию службы Firebase Auth.

Подпись:

export interface Auth 

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

Свойство	Тип	Описание
приложение	FirebaseApp	FirebaseApp , связанный с экземпляром службы Auth .
конфигурация	Конфигурация	Конфигурация , используемая для инициализации этого экземпляра.
текущий пользователь	Пользователь | нулевой	Текущий вошедший в систему пользователь (или значение NULL).
эмуляторКонфигурация	Конфигурация Эмулятора | нулевой	Текущая конфигурация эмулятора (или ноль).
языковой код	строка | нулевой	Код языка экземпляра Auth .
имя	нить	Имя приложения, связанного с экземпляром службы Auth .
настройки	Настройки аутентификации	Настройки экземпляра Auth .
идентификатор арендатора	строка | нулевой	Идентификатор клиента экземпляра Auth .

Методы

Метод	Описание
authStateReady()	возвращает обещание, которое разрешается немедленно после установления исходного состояния аутентификации. Когда обещание будет выполнено, текущий пользователь может быть действительным пользователем или null , если пользователь вышел из системы.
beforeAuthStateChanged (обратный вызов, onAbort)	Добавляет блокирующий обратный вызов, который выполняется до того, как изменение состояния аутентификации устанавливает нового пользователя.
onAuthStateChanged (nextOrObserver, ошибка, завершено)	Добавляет наблюдателя за изменениями в состоянии входа пользователя.
onIdTokenChanged (nextOrObserver, ошибка, завершено)	Добавляет наблюдателя за изменениями в токене идентификатора вошедшего в систему пользователя.
setPersistence (постоянство)	Изменяет тип сохранения экземпляра Auth .
выход()	Выполняет выход текущего пользователя. Это не приводит к автоматическому отзыву токена идентификатора пользователя.
updateCurrentUser (пользователь)	Асинхронно устанавливает предоставленного пользователя как Auth.currentUser в экземпляре Auth .
использоватьDeviceLanguage()	Устанавливает текущий язык в соответствии с настройками устройства/браузера по умолчанию.

Авторизация.приложение

FirebaseApp , связанный с экземпляром службы Auth .

Подпись:

readonly app: FirebaseApp;

Аутент.конфигурация

Конфигурация , используемая для инициализации этого экземпляра.

Подпись:

readonly config: Config;

Аутент.текущийпользователь

Текущий вошедший в систему пользователь (или значение NULL).

Подпись:

readonly currentUser: User | null;

Auth.emulatorConfig

Текущая конфигурация эмулятора (или ноль).

Подпись:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

Код языка экземпляра Auth .

Это свойство доступно для чтения/записи. Если установлено значение null, применяется настройка языка консоли Firebase по умолчанию. Код языка будет распространяться на шаблоны действий электронной почты (сброс пароля, проверка электронной почты и отзыв изменения электронной почты), шаблоны SMS для аутентификации телефона, верификатор reCAPTCHA и операции всплывающего окна/перенаправления OAuth при условии, что указанные поставщики поддерживают локализацию с указанным кодом языка.

Подпись:

languageCode: string | null;

Имя авторизации

Имя приложения, связанного с экземпляром службы Auth .

Подпись:

readonly name: string;

Настройки авторизации

Настройки экземпляра Auth .

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

Подпись:

readonly settings: AuthSettings;

Аут.тенантид

Идентификатор клиента экземпляра Auth .

Это свойство доступно для чтения/записи. Когда вы задаете идентификатор клиента экземпляра Auth , все будущие операции входа и регистрации будут передавать этот идентификатор клиента и выполнять вход или регистрацию пользователей в указанном проекте клиента. Если установлено значение null, пользователи входят в родительский проект.

Подпись:

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

Аут.аутстатериди()

возвращает обещание, которое разрешается немедленно после установления исходного состояния аутентификации. Когда обещание будет выполнено, текущий пользователь может быть действительным пользователем или null , если пользователь вышел из системы.

Подпись:

authStateReady(): Promise<void>;

Возврат:

Обещание<void>

Auth.beforeAuthStateChanged()

Добавляет блокирующий обратный вызов, который выполняется до того, как изменение состояния аутентификации устанавливает нового пользователя.

Подпись:

beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Параметры

Параметр	Тип	Описание
перезвонить	(пользователь: Пользователь | ноль) => void | Обещание<void>	обратный вызов срабатывает до того, как будет установлено новое значение пользователя. Если это выдает ошибку, установка пользователя блокируется.
onAbort	() => недействительно	обратный вызов срабатывает, если более поздний обратный вызов beforeAuthStateChanged() вызывает, что позволяет отменить любые побочные эффекты.

Возврат:

Отписаться

Аут.онАутстатечанжед()

Добавляет наблюдателя за изменениями в состоянии входа пользователя.

Чтобы сохранить старое поведение, см. Auth.onIdTokenChanged(). .

Подпись:

onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Параметры

Параметр	Тип	Описание
СледующийОрОбсервер	СледующийИлиОбсервер < Пользователь | ноль>	обратный вызов срабатывает при изменении.
ошибка	ОшибкаFn	Устарело. Этот обратный вызов никогда не запускается. Ошибки при входе/выходе могут быть обнаружены в обещаниях, возвращаемых функциями входа/выхода.
завершенный	ЗавершитьFn	Устарело. Этот обратный вызов никогда не запускается.

Возврат:

Отписаться

Аутент.онидтокенчанжед()

Добавляет наблюдателя за изменениями в токене идентификатора вошедшего в систему пользователя.

Сюда входят события входа, выхода и обновления токена.

Подпись:

onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Параметры

Параметр	Тип	Описание
СледующийОрОбсервер	СледующийИлиОбсервер < Пользователь | ноль>	обратный вызов срабатывает при изменении.
ошибка	ОшибкаFn	Устарело. Этот обратный вызов никогда не запускается. Ошибки при входе/выходе могут быть обнаружены в обещаниях, возвращаемых функциями входа/выхода.
завершенный	ЗавершитьFn	Устарело. Этот обратный вызов никогда не запускается.

Возврат:

Отписаться

Аут.сетперсистенс()

Изменяет тип сохранения экземпляра Auth .

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

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

Этот метод не работает в среде Node.js.

Подпись:

setPersistence(persistence: Persistence): Promise<void>;

Параметры

Параметр	Тип	Описание
упорство	Упорство	Настойчивость в использовании.

Возврат:

Обещание<void>

Пример

auth.setPersistence(browserSessionPersistence);

Авторизация.signOut()

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

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

Подпись:

signOut(): Promise<void>;

Возврат:

Обещание<void>

Auth.updateCurrentUser()

Асинхронно устанавливает предоставленного пользователя как Auth.currentUser в экземпляре Auth .

Будет создана новая копия предоставленного пользователя и установлена ​​как currentUser.

Это запустит прослушиватели Auth.onAuthStateChanged() и Auth.onIdTokenChanged() , как и другие методы входа.

Операция завершается ошибкой, если обновляемый пользователь принадлежит другому проекту Firebase.

Подпись:

updateCurrentUser(user: User | null): Promise<void>;

Параметры

Параметр	Тип	Описание
пользователь	Пользователь | нулевой	Новый пользователь .

Возврат:

Обещание<void>

Auth.useDeviceLanguage()

Устанавливает текущий язык в соответствии с настройками устройства/браузера по умолчанию.

Подпись:

useDeviceLanguage(): void;

Возврат:

пустота