Class EventDispatcher Abstract

Hierarchy

EventDispatcher
- Session
- StreamManager

Index

Constructors

constructor

Methods

Constructors

constructor

new EventDispatcher(): EventDispatcher

Returns EventDispatcher

Methods

Abstract off

off<K>(type: K, handler?: ((event: EventMap[K]) => void)): EventDispatcher

- Defined in OpenVidu/EventDispatcher.ts:58
Removes a handler from event type. If no handler is provided, all handlers will be removed from the event

Type Parameters
- K extends never
Parameters
- type: K
- Optional handler: ((event: EventMap[K]) => void)
  - - (event: EventMap[K]): void
    - Parameters
      - event: EventMap[K]
      Returns void
Returns EventDispatcher
The object that dispatched the event

Abstract on

on<K>(type: K, handler: ((event: EventMap[K]) => void)): EventDispatcher

- Defined in OpenVidu/EventDispatcher.ts:44
Adds function handler to handle event type

Type Parameters
- K extends never
Parameters
- type: K
- handler: ((event: EventMap[K]) => void)
  - - (event: EventMap[K]): void
    - Parameters
      - event: EventMap[K]
      Returns void
Returns EventDispatcher
The EventDispatcher object

Abstract once

once<K>(type: K, handler: ((event: EventMap[K]) => void)): EventDispatcher

- Defined in OpenVidu/EventDispatcher.ts:51
Adds function handler to handle event type just once. The handler will be automatically removed after first execution

Type Parameters
- K extends never
Parameters
- type: K
- handler: ((event: EventMap[K]) => void)
  - - (event: EventMap[K]): void
    - Parameters
      - event: EventMap[K]
      Returns void
Returns EventDispatcher
The object that dispatched the event

Generated using TypeDoc