Provides an interface for handling events on client buttons.
Methods
off(key[, handler]) :ININ.Addins.IEventHandler
Unbinds the optionally specified handler from the event key.
Inherited from ININ.Addins.IEventHandler#off
Parameters
Name | Type | Description |
---|---|---|
key | String |
The event key. |
handler | function |
The callback handler. |
Returns
This ININ.Addins.IEventHandler
instance.
on(key, handler) :ININ.Addins.IEventHandler
Binds the specified event key to the callback that can be emitted 1 or more times.
Inherited from ININ.Addins.IEventHandler#on
Parameters
Name | Type | Description |
---|---|---|
key | String |
The event key. |
handler | function |
The callback handler. |
Returns
This ININ.Addins.IEventHandler
instance.
once(key, handler) :ININ.Addins.IEventHandler
Binds the specified event key to the callback that can be emitted only once, then removed.
Inherited from ININ.Addins.IEventHandler#once
Parameters
Name | Type | Description |
---|---|---|
key | String |
The event key. |
handler | function |
The callback handler. |
Returns
This ININ.Addins.IEventHandler
instance.
Events
clicked
A click event was fired from a client button configured with add-ins.
Parameters
Name | Type | Description |
---|---|---|
clientButtonInfo | ININ.Addins.UI.Elements.IClientButtonInfo |
An |