Контекст запуска плагина
Контекст запуска плагина определяется слотом, в котором он находится, и содержит следующую информацию:
- текущая тема оформления сервиса;
- текущий язык интерфейса;
- контекст слота — данные из окружения страницы, в которой запущен плагин. Например, в слоте
issue.actionТрекера возвращается информация по открытой задаче. Точный формат контекста задается продуктовым контрактом слота и максимально приближен к типам публичного API.
Плагин получает контекст слота через usePluginContext. Набор данных получаемых данных задается параметром contextLevel в описании слота в манифесте.
Параметр contextLevel принимает два значения: базовый (basic) и полный (full) набор данных.
basic
Доступен только идентификатор текущей сущности и базовые метаданные:
type BasicContext = {
/** Идентификатор текущей сущности */
entityId: string;
/** Дополнительная базовая информация о сущности.
* Например, для комментария здесь будет идентификатор родительского тикета. */
entityMeta?: Record<string, string>;
};
Используйте basic, если плагину достаточно знать идентификатор сущности — это более легкий вариант без лишней нагрузки.
full
Полный продуктовый контекст слота. Например, для issue.action Трекера это объект Issue, а для слотов Календаря и Почты — собственные типы этих сервисов. Данные актуальны на момент открытия плагина.
Используйте full, только если плагину действительно нужны полные данные сущности.