Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

IEventController

Interface for an event controller. For controlling how events are subscribed to and unsubscribed from on a particular event manager.

Constructor | Methods

Constructor

IEventController()

Methods

NameDescription
onStartListening(events, type)

Called on the first subscription to the specified event type using the specified event manager. This method is optional.

onStopListening(events, type)

Called when a particular event type stops listening on the specified event manager (the last subscription is deleted). This method is optional.

Methods details

onStartListening

{} onStartListening(events, type)

Called on the first subscription to the specified event type using the specified event manager. This method is optional.

Parameters:

ParameterDefault valueDescription
events*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IEventManager

Event manager.

type*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: String

Type of event.

* Mandatory parameter/option.

onStopListening

{} onStopListening(events, type)

Called when a particular event type stops listening on the specified event manager (the last subscription is deleted). This method is optional.

Parameters:

ParameterDefault valueDescription
events*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IEventManager

Event manager.

type*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: String

Type of event.

* Mandatory parameter/option.