Обработчик событий сущностей

Обновлено: 18.08.2025

Хуки операций с сущностью (CRUD) Хуки жизненного цикла и воркфлоу Параметры методов Доступ к обработчику

Основные сценарии применения обработчика:

исходящие интеграции (например, отправить проект в 1С);
работа с данными (предварительно заполнить свойства, выполнить проверки);
взаимодействие с пользователями (отправить уведомление, поставить задачу на выполнение).

Обработчик представляет собой класс на C# для каждого типа сущности. В системе он наследует абстрактный класс EntityTypeCustomHooks<TEntity>. Методы в нём объявлены как virtual с реализацией по умолчанию Task.CompletedTask. Переопределять нужно только те методы, логика которых требуется.

Хуки операций с сущностью (CRUD)

В обработчике доступны четыре переопределяемых метода (хука), которые вызываются при операциях с сущностью:

Хук	Когда вызывается	Параметры
BeforeUpsert	До вставки или обновления сущности. Используется для базовых проверок.	`context`, `detachedEntity`
AfterUpsert	После вставки или обновления. Предназначен для бизнес-логики: предзаполнение свойств, исходящие интеграции.	`context`, `contextEntity`, `detachedEntity`
BeforeDelete	До удаления сущности.	`context`, `detachedEntity`
AfterDelete	После удаления сущности.	`context`, `contextEntity`

Хуки жизненного цикла и воркфлоу

Помимо CRUD-хуков в обработчике доступны три метода, связанные со сменой состояния и запуском воркфлоу:

Хук	Когда вызывается	Параметры
BeforeSetState	До смены состояния сущности в жизненном цикле	`context`, `entity`, `oldStateId`, `newStateId`
AfterSetState	После смены состояния	`context`, `entity`, `oldStateId`, `newStateId`
BeforeStartWorkflow	Перед запуском воркфлоу по сущности	`context`, `contextEntity`

Эти методы можно переопределять так же, как и остальные хуки. По умолчанию у них пустая реализация.

Параметры методов

В методы передаются следующие параметры:

context — контекст обработчика (CustomHooksContext). Представляет собой SDK для ограниченной работы с приложением;
detachedEntity — сущность, переданная через API пользователем;
contextEntity — сущность, извлечённая из БД для обновления. При вставке идентична detachedEntity.