identity namespace

Функции

Функция Описание
beforeOperation (eventType, optsOrHandler, обработчик)
beforeUserCreated (обработчик) Обрабатывает событие, которое срабатывает перед созданием пользователя.
beforeUserCreated (опции, обработчик) Обрабатывает событие, которое срабатывает перед созданием пользователя.
beforeUserSignedIn (обработчик) Обрабатывает событие, которое срабатывает перед входом пользователя в систему.
beforeUserSignedIn(opts, обработчик) Обрабатывает событие, которое срабатывает перед входом пользователя в систему.
getOpts (блокирующие параметры)

Классы

Сорт Описание
HttpsError Явная ошибка, которая может быть вызвана обработчиком для отправки ошибки клиенту, вызвавшему функцию.

Интерфейсы

Интерфейс Описание
AuthBlockingEvent Определяет событие аутентификации для событий блокировки 2-го поколения.
АвторизацияПользовательРекорд UserRecord передается функциям блокировки аутентификации с платформы идентификации.
Параметры блокировки Все параметры функции, а также idToken, accessToken иrefreToken.

личность.beforeOperation()

Подпись:

export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>), handler: (event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;

Параметры

Параметр Тип Описание
тип события Аутблоккингевенттипе
optsOrHandler Параметры блокировки | ((событие: AuthBlockingEvent ) => BeforeCreateResponse | ПреждеSignInResponse | пустота | Обещание<BeforeCreateResponse> | Обещание<BeforeSignInResponse> | Обещание<недействительно>)
обработчик (событие: AuthBlockingEvent ) => BeforeCreateResponse | ПреждеSignInResponse | пустота | Обещание<BeforeCreateResponse> | Обещание<BeforeSignInResponse> | Обещание<void>

Возврат:

Блокирующая функция

личность.beforeUserCreated()

Обрабатывает событие, которое срабатывает перед созданием пользователя.

Подпись:

export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

Параметры

Параметр Тип Описание
обработчик (событие: AuthBlockingEvent ) => BeforeCreateResponse | Обещание<BeforeCreateResponse> | пустота | Обещание<void> Обработчик событий, который запускается каждый раз перед созданием пользователя.

Возврат:

Блокирующая функция

личность.beforeUserCreated()

Обрабатывает событие, которое срабатывает перед созданием пользователя.

Подпись:

export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

Параметры

Параметр Тип Описание
выбирает Параметры блокировки Объект, содержащий параметры функции
обработчик (событие: AuthBlockingEvent ) => BeforeCreateResponse | Обещание<BeforeCreateResponse> | пустота | Обещание<void> Обработчик событий, который запускается каждый раз перед созданием пользователя.

Возврат:

Блокирующая функция

личность.beforeUserSignedIn()

Обрабатывает событие, которое срабатывает перед входом пользователя в систему.

Подпись:

export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

Параметры

Параметр Тип Описание
обработчик (событие: AuthBlockingEvent ) => Передподписываниемответа | Обещание<BeforeSignInResponse> | пустота | Обещание<void> Обработчик событий, который запускается каждый раз перед входом пользователя в систему.

Возврат:

Блокирующая функция

личность.beforeUserSignedIn()

Обрабатывает событие, которое срабатывает перед входом пользователя в систему.

Подпись:

export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

Параметры

Параметр Тип Описание
выбирает Параметры блокировки Объект, содержащий параметры функции
обработчик (событие: AuthBlockingEvent ) => Преждеподписьвответ | Обещание<BeforeSignInResponse> | пустота | Обещание<void> Обработчик событий, который запускается каждый раз перед входом пользователя в систему.

Возврат:

Блокирующая функция

личность.getOpts()

Подпись:

export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;

Параметры

Параметр Тип Описание
параметры блокировки Параметры блокировки

Возврат:

Внутренние параметры