Class KeyHandler

Abstract class that integrates E2EEContext with a key management system.

Hierarchy (View Summary)

Listenable
- KeyHandler
  - ExternallyManagedKeyHandler
  - ManagedKeyHandler

Index

Constructors

Properties

_enabling _firstEnable conference e2eeCtx enabled

Methods

addCancellableListener addEventListener addListener emit isEnabled listenerCount off on once removeAllListeners removeEventListener removeListener setEnabled

Constructors

constructor

new KeyHandler(conference: JitsiConference, options?: any): KeyHandler
Build a new KeyHandler instance, which will be used in a given conference.
Parameters
- conference: JitsiConference
  the current conference.
- options: any = {}
  the options passed to {E2EEContext}, see implemention.
Returns KeyHandler
Overrides Listenable.constructor
- Defined in modules/e2ee/KeyHandler.js:22

Properties

_enabling

_enabling: Deferred<any>

_firstEnable

_firstEnable: boolean

conference

conference: JitsiConference

e2eeCtx

e2eeCtx: E2EEcontext

enabled

enabled: boolean

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.
Inherited from Listenable.addCancellableListener
- Defined in modules/util/Listenable.ts:73

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
Inherited from Listenable.addEventListener
- Defined in modules/util/Listenable.ts:54

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.
Inherited from Listenable.addListener
- Defined in modules/util/Listenable.ts:85

emit

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

isEnabled

isEnabled(): boolean
Indicates whether E2EE is currently enabled or not.

Returns boolean
- Defined in modules/e2ee/KeyHandler.js:56

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.
Inherited from Listenable.listenerCount
- Defined in modules/util/Listenable.ts:120

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
Inherited from Listenable.off
- Defined in modules/util/Listenable.ts:36

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
Inherited from Listenable.on
- 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
Inherited from Listenable.once
- Defined in modules/util/Listenable.ts:45

removeAllListeners

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

Returns void
Inherited from Listenable.removeAllListeners
- Defined in modules/util/Listenable.ts:111

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
Inherited from Listenable.removeEventListener
- Defined in modules/util/Listenable.ts:63

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.
Inherited from Listenable.removeListener
- Defined in modules/util/Listenable.ts:96

setEnabled

setEnabled(enabled: boolean): void
Enables / disables End-To-End encryption.
Parameters
- enabled: boolean
  whether E2EE should be enabled or not.
Returns void
- Defined in modules/e2ee/KeyHandler.js:66