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- это глобальная переменная для потока событий. Больше информации по использованию этих методов представлено в статье Global Client Events.
on(eventType, callback)
A subscription to an eventДанный метод осуществляет подписку на событие.
ParametersПараметры:
NameНазвание | TypeТип | MandatoryОбязательный | Default ValueДефолтное значение |
---|---|---|---|
eventType | String | YД | NН |
callback | callback | YД | NН |
ReturnВозврат:
TypeТип | DescriptionОписание |
---|---|
Object | Contains 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 | String | YД | NН | ||||
data | Any | NН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 | ||
---|---|---|
|