Class Listenable

The class implements basic event operations - add/remove listener. NOTE: The purpose of the class is to be extended in order to add this functionality to other classes.

Hierarchy (View Summary)

Listenable
- JitsiConference
- JitsiMediaDevices

Index

Constructors

Methods

addCancellableListener addEventListener addListener emit listenerCount off on once removeAllListeners removeEventListener removeListener

Constructors

constructor

new Listenable(): Listenable
Creates new instance.

Returns Listenable
- Defined in modules/util/Listenable.ts:17

Methods

addCancellableListener

addCancellableListener(eventName: string, listener: EventListener): () => void
Adds new cancellable listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns () => void
- The unsubscribe function.
- Defined in modules/util/Listenable.ts:77

addEventListener

addEventListener(eventId: string, handler: EventListener): void
Alias for on method.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
- Defined in modules/util/Listenable.ts:58

addListener

addListener(eventName: string, listener: EventListener): EventEmitter
Adds new listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
- Defined in modules/util/Listenable.ts:89

emit

emit(event: string, ...args: any[]): void
Emits an event.
Parameters
- event: string
  event name
- ...args: any[]
Returns void
- Defined in modules/util/Listenable.ts:108

listenerCount

listenerCount(eventName?: string): number
Returns the number of listeners for the specified event.
Parameters
- OptionaleventName: string
  The name of the event.
Returns number
- The number of listeners for the event.
- Defined in modules/util/Listenable.ts:124

off

off(eventId: string, handler?: EventListener): void
Removes event listener.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
- Defined in modules/util/Listenable.ts:38

on

on(eventId: string, handler: EventListener): void
Attaches a handler for events (e.g., "participant joined") in the conference. All possible events are defined in JitsiConferenceEvents.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
- Defined in modules/util/Listenable.ts:27

once

once(eventId: string, handler: EventListener): void
Adds a one-time listener function for the event.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
- Defined in modules/util/Listenable.ts:49

removeAllListeners

removeAllListeners(): void
Removes all listeners for the event emitter.

Returns void
- Defined in modules/util/Listenable.ts:115

removeEventListener

removeEventListener(eventId: string, handler?: EventListener): void
Alias for off method.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
- Defined in modules/util/Listenable.ts:67

removeListener

removeListener(eventName: string, listener: EventListener): EventEmitter
Removes listener.
Parameters
- eventName: string
  the name of the event that triggers the listener
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
- Defined in modules/util/Listenable.ts:100