Class ExternallyManagedKeyHandler

This module integrates E2EEContext with {external} in order to set the keys for encryption.

Hierarchy (View Summary)

KeyHandler
- ExternallyManagedKeyHandler

Index

Constructors

constructor

new ExternallyManagedKeyHandler(conference: any): ExternallyManagedKeyHandler
Build a new ExternallyManagedKeyHandler instance, which will be used in a given conference.
Parameters
- conference: any
  the current conference.
Returns ExternallyManagedKeyHandler
Overrides KeyHandler.constructor
- Defined in modules/e2ee/ExternallyManagedKeyHandler.js:11

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 KeyHandler.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 KeyHandler.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 KeyHandler.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 KeyHandler.emit
- Defined in modules/util/Listenable.ts:104

isEnabled

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

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

removeAllListeners

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

Returns void
Inherited from KeyHandler.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 KeyHandler.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 KeyHandler.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
Inherited from KeyHandler.setEnabled
- Defined in modules/e2ee/KeyHandler.js:66

setKey

setKey(keyInfo: any): void
Sets the key and index for End-to-End encryption.
Parameters
- keyInfo: any
Returns void
- Defined in modules/e2ee/ExternallyManagedKeyHandler.js:22