1
0
mirror of https://github.com/salexdv/bsl_console.git synced 2024-11-28 08:48:48 +02:00
bsl_console/docs/get_metadata_event.md
2022-01-30 15:29:58 +03:00

27 lines
3.1 KiB
Markdown

# Событие *EVENT_GET_METADATA*
## Назначение события
Событие генерируется в случае, когда структура метаданных пуста т.е. еще не разу не вызывалась функция API [`updateMetadata`](update_metadata.md)
## Параметры события
В параметрах события указывается для каких конкретно метаданных невозможно построить подсказку, а также триггер, вызвавший событие и произвольные дополнительные параметры
* **metadata** - вид запрашиваемых метаданных
* **trigger** - триггер, вызвавший запрос метаданных
## Триггеры
* **suggestion** - запрос метаданных при построении списка подсказок. После обновления метаданных следует вызвать метод редактора [`triggerSuggestions`](trigger_suggestions.md)
* **snippet** - запрос метаданных при построении шаблона кода (сниппета). После обновления метаданных следует вызвать метод редактора [`updateSnippetByGUID`](update_snippet_guid.md) и передать в него поле `snippet_guid` из параметров события
## Примеры
* **справочники** - требуется загрузить через [`updateMetadata`](update_metadata.md) структуру справочников. Для увеличения быстродействия можно загрузить только имена справочников, не получая их реквизиты.
* **справочники.номенклатура** - требуется загрузить структуру справочника `Номенклатура`.
* **документы** - требуется загрузить через [`updateMetadata`](update_metadata.md) структуру всех документов (можно только имена).
* **документы.авансовыйотчет** - требуется загрузить структуру документа `АвансовыйОтчет`.
* **module.УправлениеСвойствами** - требуется загрузить через [`parseCommonModule`](parse_module.md) структуру общего модуля `УправлениеСвойствами`.
* **module.manager.документы.авансовыйотчет** - требуется загрузить через [`parseMetadataModule`](parse_metadata_module.md) структуру модуля менеджера документа `АвансовыйОтчет`.
* **module.object.документы.авансовыйотчет** - требуется загрузить через [`parseMetadataModule`](parse_metadata_module.md) структуру модуля документа `АвансовыйОтчет`.