Функции могут быть вызваны как UseModule("Collaboration")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| AddMention | Добавить упоминание
 Подробнее...
Добавляет к сообщению Collaboration упоминание пользователя, группы, роли или внешнего участника, сохраняет аудит и готовит событие для системной событийной шины. | | Тип | Параметр | По умолчанию | Описание | | String | $messageKey | '' | Ключ сообщения Collaboration. | | Array | $mention | array (
) | Данные упоминания: mentionKind или kind, mentionKey или key, mentionTitle или title, visibility. | | Array | $options | array (
) | Технические параметры: traceId. |
|
| AddMessage | Добавить сообщение в поток
Подробнее...
Добавляет сообщение в поток Collaboration, применяет уровень видимости, сохраняет упоминания, ссылки, привязки вложений и готовит событие для системной событийной шины. | | Тип | Параметр | По умолчанию | Описание | | String | $threadKey | '' | Ключ потока коммуникаций. | | Array | $data | array (
) | Данные сообщения: text, messageTypeKey, parentMessageKey, author, visibility, mentions, attachments, references. | | Array | $options | array (
) | Технические параметры: idempotencyKey и traceId. |
|
| AddReaction | Добавить реакцию
Подробнее...
Добавляет реакцию пользователя на сообщение Collaboration, сохраняет аудит, поддерживает идемпотентность и готовит событие для системной событийной шины. | | Тип | Параметр | По умолчанию | Описание | | String | $messageKey | '' | Ключ сообщения Collaboration. | | String | $reactionKey | 'like' | Ключ реакции, например like или approve. | | Array | $author | array (
) | Автор реакции: kind, key, title. | | Array | $options | array (
) | Технические параметры: idempotencyKey и traceId. |
|
| AddReference | Добавить ссылку сообщения
Подробнее...
Добавляет к сообщению Collaboration ссылку на запись ИРБИС 128, внешний адрес или документ, сохраняет аудит и готовит событие для системной событийной шины. | | Тип | Параметр | По умолчанию | Описание | | String | $messageKey | '' | Ключ сообщения Collaboration. | | Array | $reference | array (
) | Данные ссылки: targetKind, targetKey, moduleKey, dbn, recordType, recordKey, mfn, url, title, visibility. | | Array | $options | array (
) | Технические параметры: traceId. |
|
| BuildPublicThreadDto | Сформировать публичную DTO потока
Подробнее...
Возвращает безопасное публичное представление потока Collaboration: только публичные сообщения и связи, без внутренних, технических, конфиденциальных и персональных данных. | | Тип | Параметр | По умолчанию | Описание | | String | $threadKey | '' | Ключ потока коммуникаций. | | Array | $context | array (
) | Дополнительный контекст публичного запроса. |
|
| ChangeMessageVisibility | Изменить видимость сообщения
Подробнее...
Изменяет уровень видимости сообщения Collaboration, перестраивает проекцию ленты, сохраняет аудит и готовит событие для системной событийной шины. | | Тип | Параметр | По умолчанию | Описание | | String | $messageKey | '' | Ключ сообщения Collaboration. | | String | $visibility | 'internal' | Новый уровень видимости: public, internal, confidential, technical или personal. | | Array | $options | array (
) | Технические параметры: idempotencyKey и traceId. |
|
| EnsureSchema | Инициализировать хранилища коммуникаций
Подробнее...
Создает или обновляет SID SQLite-хранилища модуля Collaboration и фиксирует текущую версию runtime-схемы в записи модуля. | Отсутствуют |
| ExplainVisibilityDecision | Объяснить решение по видимости сообщения
Подробнее...
Возвращает понятное решение политики видимости Collaboration: можно ли показать сообщение с указанным уровнем видимости в заданном контексте пользователя и почему принято такое решение. | | Тип | Параметр | По умолчанию | Описание | | String | $visibility | 'internal' | Уровень видимости: public, internal, confidential, technical или personal. | | Array | $context | array (
) | Контекст доступа: authenticated, admin, visibilityLevels или allowedVisibility. |
|
| GetSchemaStatus | Проверить состояние хранилищ коммуникаций
Подробнее...
Возвращает диагностическое состояние runtime-схемы Collaboration: наличие записи модуля, версию схемы, список хранилищ, недостающие колонки и количество строк. | Отсутствуют |
| GetSystemDefinitions | Получить системные определения коммуникаций
Подробнее...
Читает поставляемый модулем Collaboration JSON с системными пространствами, типами потоков, типами сообщений, уровнями видимости, API-схемами, миграционными профилями и TestA-сценариями. | Отсутствуют |
| GetThreadFeed | Получить ленту потока коммуникаций
Подробнее...
Возвращает поток и видимые пользователю сообщения с отношениями сообщения. Фильтрация выполняется по стандартным уровням видимости Collaboration. | | Тип | Параметр | По умолчанию | Описание | | String | $threadKey | '' | Ключ потока коммуникаций. | | Array | $context | array (
) | Контекст доступа: authenticated, admin, visibilityLevels или allowedVisibility. |
|
| HealthCheck | Диагностика модуля коммуникаций
Подробнее...
Проверяет runtime-схему Collaboration, системные определения и наличие обязательных внешних контрактов: EventBus, FT, TemporaryFiles, Security и TestA. | Отсутствуют |
| LinkAttachment | Привязать вложение
Подробнее...
Привязывает к сообщению Collaboration ссылку на постоянный объект FT или staging-token TemporaryFiles, не сохраняя файл внутри Collaboration. | | Тип | Параметр | По умолчанию | Описание | | String | $messageKey | '' | Ключ сообщения Collaboration. | | Array | $attachment | array (
) | Данные вложения: attachmentKey, ftObjectKey, tempToken, title, categoryKey, visibility, quarantineState. | | Array | $options | array (
) | Технические параметры: traceId. |
|
| OpenThread | Открыть поток коммуникаций
Подробнее...
Создает поток коммуникаций для доменного объекта ИРБИС 128. Метод принимает ссылку на объект-владелец, тип потока, заголовок, уровень видимости и ключ идемпотентности. | | Тип | Параметр | По умолчанию | Описание | | Array | $data | array (
) | Данные потока: object, threadKey, spaceKey, threadTypeKey, title, visibility, status, participant. | | Array | $options | array (
) | Технические параметры: idempotencyKey и traceId. |
|
| RebuildFeedProjection | Перестроить проекцию ленты коммуникаций
Подробнее...
Удаляет и заново строит materialized-проекцию ленты для указанного потока. Проекция нужна для быстрых списков, карточек и последующей диагностики. | | Тип | Параметр | По умолчанию | Описание | | String | $threadKey | '' | Ключ потока коммуникаций. |
|
| RenderRecordComments | Показать комментарии записи
Подробнее...
Формирует универсальный HTML-блок комментариев Collaboration для карточки записи Workflow: читает поток сообщений по ссылке на запись, обрабатывает отправку нового комментария и сохраняет сообщение через runtime Collaboration. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataDatabase | $db | '' | База данных, в которой находится комментируемая запись. | | ObjectDataRecord | $record | '' | Комментируемая запись ИРБИС 128. | | ObjectDataWorkflowProject | $project | '' | Проект Workflow, в контексте которого открыта карточка записи. | | string | $recordType | '' | Тип записи из поля 920. | | string | $pageKey | '' | Ключ страницы карточки WorkflowView. | | array | $options | 'array()' | Параметры вывода: title, wrapperClass, emptyText, submitTitle, visibility, allowForm, contentOnly. |
|
| ValidateSystemDefinitions | Проверить системные определения коммуникаций
Подробнее...
Проверяет поставляемый system JSON модуля Collaboration: обязательные секции, версию схемы, имя модуля и наличие стандартных уровней видимости. | | Тип | Параметр | По умолчанию | Описание | | Array | $definitions | Обязательный | Необязательный массив системных определений. Если параметр не передан, используется файл modules/Collaboration/system/collaboration.json. |
|