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

event.unbind

Права на выполнение: администратор

Отмена зарегистрированного обработчика события.

Работает только при авторизации под пользователем с правами администрирования портала.

Параметры

Параметр Описание
event Имя события. Обязательный.
handler Ссылка на обработчик события. Обязательный.
auth_type Идентификатор пользователя, под которым авторизуется обработчик события. Не обязательный.

Примечание: если требуется удалить обработчики события, установленные с пустым auth_type (с авторизацией от имени пользователя, вызвавшего событие), но оставить остальные обработчики, указывайте auth_type=0 или пустое значение параметра.

event_type Значения: online|offline. По умолчанию event_type=online, и поведение метода не меняется. Если казывается event_type=offline, то метод работает с офлайн событиями.

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

Возвращаемое значение

Метод вернет количество удаленных при вызове обработчиков событий.

Пример:

https://my.bitrix24.ru/rest/event.unbind.json?auth=a25e86871fcebb24f4d9076caf2e6623&auth_type=0&event=OnAppUpdate&handler=http%3A%2F%2Fwww.my-domain.ru%2Fhandler%2F

Ответ:

{"result":{"count":1}}

Смотри также



© «Битрикс», 2001-2024, «1С-Битрикс», 2024