Реакция на клик

ActionDto — действие определяет реакцию на клик по определенному элементу записи таймлайна. Существует несколько различных видов действий, каждое из которых имеет свой формат.

Переход по ссылкеПереход по ссылке

Если будет использована относительная ссылка на стандартные объекты Битрикс24, поддерживающие открытие в слайдере, будет показан слайдер. Иначе будет обычный переход по ссылке.

ПараметрыПараметры

Обязательные параметры отмечены *

ПримерПример

{
            "type": "redirect",
            "uri": "/crm/deal/details/1/"
        }
        

CобытиеCобытие

Вызов действия приведет к генерации события onCrmTimelineItemAction. При возникновении события будут вызваны обработчики только приложения, создавшего эту запись таймлайна. В обработчик всегда будет передан контекст:

• id - идентификатор события,
• entityTypeId - идентификатор типа объекта, к которому привязано дело,
• entityId - идентификатор элемента этого объекта,
• activityId - идентификатор дела,
• userId - идентификатор пользователя, вызвавшего действие.

ПараметрыПараметры

Обязательные параметры отмечены *

В некоторых случаях отправка события подразумевает, что обработчик этого события должен изменить внешний вид записи в таймлайне. Например, добавить новые блоки или изменить набор кнопок.

Чтобы пользователь видел обновление, можно использовать параметр animationType. Если animationType имеет значение loader — запись в таймлайне будет заблокирована и поверх нее появится лоадер. Блокировка будет длиться до обновления записи через crm.activity.configurable.update.
Если действие вызвано нажатием по кнопке в нижней части таймлайна и animationType имеет значение disable — эта кнопка будет заблокирована до обновления записи через crm.activity.configurable.update.

ПримерПример

{
            "type": "restEvent",
            "id": "resetButtonClick",
            "actionParams": {
                "myId": 123,
                "someImportant": "qwerty"
            },
            "animationType": "disable"
        }
        

Действие назначено на кнопку. Нажатие на нее приведет к вызову обработчика события onCrmTimelineItemAction, зарегистрированного приложением, которое создало запись таймлайна.
В обработчик будут переданы стандартные параметры id=resetButtonClick, entityTypeId, entityId, activityId, userId и параметры определенные разработчиком — myId=123 и someImportant=qwerty. Кнопка заблокируется с момента нажания и до обновления записи таймлайна через crm.activity.configurable.update.

Открытие слайдера приложенияОткрытие слайдера приложения

Вызов действия приведет к открытию слайдера приложения, создавшего запись таймлайна. В слайдер будет передан контекст:

• entityTypeId - идентификатор типа объекта, к которой привязано дело,
• entityId - идентификатор элемента этого объекта,
• activityId - идентификатор дела.

ПараметрыПараметры

Обязательные параметры отмечены *

ПримерПример

{
            "type": "openRestApp",
            "actionParams": {
                "myId": 123,
                "someImportant": "qwerty"
            },
            "sliderParams": {
                "title": "Это заголовок слайдера приложения",
                "width": 700
            }
        }
        

ActionSliderParamsDtoActionSliderParamsDto

Параметры открытия слайдера приложенияПараметры открытия слайдера приложения

Продолжите изучениеПродолжите изучение

• Структура конфигурируемого дела
• Иконка
• Заголовок записи
• Основная контентная область конфигурируемого дела
• Контентный блок конфигурируемого дела
• Нижняя часть записи
• Выпадающее меню нижней части
• Типы полей
• Набор дополнительных контентных блоков
• Примеры конфигураций дел