Документация для разработчиков
Темная тема

PullManager

Описание и методы

Bitrix\Rpa\Integration\PullManager - класс для рассылки пушей.

Может работать только после подключения модуля pull. Модуль подключается в конструкторе.

У класса есть методы подписки на пуши и рассылки пушей.

Методы

Метод Описание С версии
public function isEnabled(): bool Возвращает true, если модуль pull был успешно подключен и пуши работают.

Подписка на события

Методы подписки на события в случае успешной подписки возвращают тэг. Если тэга нет, значит не удалось подписаться.

Метод Описание С версии
public function subscribeOnTimelineUpdate(int $typeId, int $itemId): ?string Подписка на все события таймлайна элемента с идентификатором $itemId процесса с идентификатором$typeId.
public function subscribeOnKanbanUpdate(int $typeId): ?string Подписка на все события канбана процесса с идентификатором $typeId.
public function subscribeOnItemUpdatedEvent(int $typeId, int $itemId): ?string Подписка на событие изменения элемента с идентификатором $itemId процесса с идентификатором$typeId.
public function subscribeOnTaskCounters(): ?string Подписка на событие изменения счетчиков заданий.

Рассылка пушей

Методы рассылки возвращают true, если пуш был отправлен.

Если на входе метода есть $eventId - это строковый идентификатор события, который будет передан в пуш.

Метод Описание С версии
public function sendTimelineAddEvent(Timeline $timeline, string $eventId = ''): bool Отправляет пуш о добавлении записи таймлайна $timeline.
public function sendTimelineUpdateEvent(Timeline $timeline, string $eventId = ''): bool Отправляет пуш об изменении записи таймлайна $timeline.
public function sendTimelinePinEvent(Timeline $timeline, string $eventId = ''): bool Отправляет пуш об изменении статуса флага прикрепления записи таймлайна.
public function sendTimelineDeleteEvent(int $typeId, int $itemId, int $timelineId, string $eventId = ''): bool Отправляет пуш об удалении записи таймлайна с идентификаторо $timelineId элемента $itemId процесса $typeId.
public function sendItemAddedEvent(Item $item, string $eventId = ''): bool Отправляет пуш о добавлении элемента $item.
public function sendItemUpdatedEvent(Item $item, string $eventId = '', Item $historyItem = null): bool Отправляет пуш об обновлении элемента $item.
public function sendItemDeletedEvent(Item $item, string $eventId = ''): bool Отправляет пуш об удалении элемента $item.
public function sendRobotAddedEvent(int $typeId, int $stageId, array $data = []): bool Отправляет пуш о добавлении нового робота с данными $data на стадии $stageId процесса $typeId.
public function sendRobotUpdatedEvent(int $typeId, int $stageId, array $data = []): bool Отправляет пуш об изменении робота с данными $data на стадии $stageId процесса $typeId.
public function sendRobotDeletedEvent(int $typeId, int $stageId, string $robotName, string $eventId = ''): bool Отправляет пуш об удалении робота с именем $robotName на стадии $stageId процесса $typeId.
public function sendTypeUpdatedEvent(Type $type, string $eventId = ''): bool Отправляет пуш о добавлении нового процесса $type.
public function sendStageAddedEvent(Stage $stage, string $eventId = ''): bool Отправляет пуш о добавлении новой стадии $stage.
public function sendStageUpdatedEvent(Stage $stage, string $eventId = ''): bool Отправляет пуш об изменении стадии $stage.
public function sendStageDeletedEvent(int $stageId, int $typeId, string $eventId = ''): bool Отправляет пуш об удалении стадии с идентификатором $stageId процесса $typeId
public function sendTaskCountersEvent(int $typeId, int $itemId, array $counters): bool< Отправляет пуш об изменении счетчиков элемента $itemId процесса $typeId.

Информация о счетчиках $counters должна иметь следующий вид: Ключ - это идентификатор пользователя, а значение - это строка '+1', если счетчик был увеличен, и '-1', если счетчик был уменьшен

public function addItemUpdateEventId(int $typeId, int $itemId, string $eventId): PullManager Добавляет идентификатор события $eventId об изменении элемента с идентификатором $itemId процесса с идентификатором $itemId.

При работе автоматизации бывает трудно добраться до потока управления, чтобы передать туда идентификатор события в явном виде.

Чтобы этот идентификатор не потерялся, он может быть добавлен с помощью этого метода

.


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх