Перейти к основному содержимому
Версия: 1.20.1

SimpleEventBus

Данный класс содержит методы для работы с потоком событий. О системных коробочных событиях, с которыми этот класс может взаимодействовать, подробно написано в статье Глобальные клиентские события.

on(eventType, callback)


Используйте метод, чтобы подписаться на событие.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
eventTypeStringДаНет
callbackFunctionДаНет

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

ТипОписание
ObjectОбъект, содержащий метод отписки от события.

Пример:

on()
const obj = SimpleEventBus.on('myEvent', (data) => { alert(data); })
obj.unsubscribe();

emit(eventType, data)


Используйте этот метод в клиентских скриптах или виджетах для инициализации события.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
eventTypeStringДаНет
dataAnyНетНет

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

ТипОписание
VoidМетод не возвращает значение.

Пример:

emit()
SimpleEventBus.emit('myEvent', 'text')

deleteEvent(eventType)


Используйте этот метод для удаления события.

Параметры:

НаименованиеТипОбязательноЗначение по умолчанию
eventTypeStringДаНет

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

ТипОписание
VoidМетод не возвращает значение.

Пример:

deleteEvent()
const obj = SimpleEventBus.deleteEvent('myEvent')

reset()


Используйте этот метод для сброса всех событий и подписок.

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

ТипОписание
VoidМетод не возвращает значение.

Пример:

reset()
SimpleEventBus.reset()