Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
SimpleEventBus is a global variable for the event stream. See Global Client Events for more information on the usage of these methodsДанный класс содержит методы для работы с потоком событий. О системных коробочных событиях, с которыми этот класс может взаимодействовать, подробно написано в статье Глобальные клиентские события.
on(eventType, callback)
A subscription to an eventИспользуйте метод, чтобы подписаться на событие.
ParametersПараметры:
NameНазвание | TypeТип | Mandatory | Обязательный | Значение по умолчаниюDefault Value |
---|---|---|---|---|
eventType | StringY | Да | NНет | |
callbackcallback | FunctionY | Да | NНет |
ReturnВозвращаемое значение:
TypeТип | DescriptionОписание |
---|---|
ObjectContains | the unsubscribe methodОбъект, содержащий метод отписки от события. |
ExampleПример:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
const obj = SimpleEventBus.on('myEvent', (data) => { alert(data); }) obj.unsubscribe(); |
emit(eventType, data)
This method starts an event. Use it in client scripts of the widgets.
Parameters:
Используйте этот метод в клиентских скриптах или виджетах для инициализации события.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию | Name | Type | Mandatory | Default Value |
---|---|---|---|---|---|---|---|
eventType | StringY | Да | NНет | ||||
data | AnyN | Нет | NНет |
ReturnВозвращаемое значение:
TypeТип | DescriptionОписание |
---|---|
VoidThis | method does not return a valueМетод не возвращает значение. |
ExampleПример:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
const obj = SimpleEventBus.emit('myEvent', 'text') |
deleteEvent(eventType)
Deletes an eventИспользуйте этот метод для удаления события.
ParameterПараметр:
NameНазвание | TypeТип | Mandatory | Обязательный | Значение по умолчаниюDefault Value |
---|---|---|---|---|
eventType | String | YДа | NНет |
ReturnВозвращаемое значение:
TypeТип | DescriptionОписание |
---|---|
VoidThis | method does not return a valueМетод не возвращает значение. |
ExampleПример:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
const obj = SimpleEventBus.deleteEvent('myEvent') |
reset()
This method resets all events and subscriptions.
Return:
Используйте этот метод для сброса всех событий и подписок.
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
ПримерExample:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
SimpleEventBus.reset() |
Table of Contents | ||
---|---|---|
|