Class: FishjamWSNotifier
Defined in: packages/js-server-sdk/packages/js-server-sdk/src/ws_notifier.ts:45
Notifier object that can be used to get notified about various events related to the Fishjam App.
Extends
TypedEventEmitter<NotificationEvents,this>
Constructors
new FishjamWSNotifier()
new FishjamWSNotifier(
config,onError,onClose,onConnectionFailed):FishjamWSNotifier
Defined in: packages/js-server-sdk/packages/js-server-sdk/src/ws_notifier.ts:48
Parameters
| Parameter | Type |
|---|---|
config | FishjamConfig |
onError | ErrorEventHandler |
onClose | CloseEventHandler |
onConnectionFailed | ErrorEventHandler |
Returns
Overrides
(EventEmitter as new () => TypedEmitter<NotificationEvents>).constructor
Methods
addListener()
addListener<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:22
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).addListener
emit()
emit<
E>(event, ...args):boolean
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:32
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
...args | Parameters<NotificationEvents[E]> |
Returns
boolean
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).emit
eventNames()
eventNames(): (
string|symbol)[]
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:34
Returns
(string | symbol)[]
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).eventNames
getMaxListeners()
getMaxListeners():
number
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:39
Returns
number
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).getMaxListeners
listenerCount()
listenerCount<
E>(event):number
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:37
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
Returns
number
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).listenerCount
listeners()
listeners<
E>(event):NotificationEvents[E][]
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:36
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
Returns
NotificationEvents[E][]
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).listeners
off()
off<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:28
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).off
on()
on<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:23
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).on
once()
once<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:24
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).once
prependListener()
prependListener<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:25
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).prependListener
prependOnceListener()
prependOnceListener<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:26
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).prependOnceListener
rawListeners()
rawListeners<
E>(event):NotificationEvents[E][]
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:35
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
Returns
NotificationEvents[E][]
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).rawListeners
removeAllListeners()
removeAllListeners<
E>(event?):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:29
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event? | E |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).removeAllListeners
removeListener()
removeListener<
E>(event,listener):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:30
Type Parameters
| Type Parameter |
|---|
E extends ExpectedEvents |
Parameters
| Parameter | Type |
|---|---|
event | E |
listener | NotificationEvents[E] |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).removeListener
setMaxListeners()
setMaxListeners(
maxListeners):this
Defined in: packages/js-server-sdk/node_modules/typed-emitter/index.d.ts:40
Parameters
| Parameter | Type |
|---|---|
maxListeners | number |
Returns
this
Inherited from
(EventEmitter as new () => TypedEmitter<NotificationEvents>).setMaxListeners