Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserPresenceManager

Hierarchy

Index

Methods

addListener

  • Adds a new event listener for the specified event. The class will ignore duplicate registrations of the same listener to the same event.

    Parameters

    • event: string

      The name of the event to add the listener for.

    • listener: ConvergenceEventListener<any>

      The listener callback to register.

    Returns ConvergenceEventEmitter<any>

    This object, in support of a fluent API.

asObservable

availability

  • availability(availability: boolean): void
  • Parameters

    • availability: boolean

    Returns void

clear

  • clear(): void
  • Returns void

events

  • events(): Observable<any>
  • Provides the events emitted by this object as an Observable stream.

    example
    
    eventEmitter.events()
      .filter(e => e.name === "myevent")
      .subscribe(e => console.log(e));

    Returns Observable<any>

    An Observable stream of all events emitted by this object.

isAvailable

  • isAvailable(): boolean
  • Returns boolean

off

on

  • Adds a new event listener for the specified event. The class will ignore duplicate registrations of the same listener to the same event.

    Parameters

    • event: string

      The name of the event to add the listener for.

    • listener: ConvergenceEventListener<any>

      The listener callback to register.

    Returns ConvergenceEventEmitter<any>

    This object, in support of a fluent API.

once

  • Adds a single shot event listener for the specified event. The listener will be called the first time the specified event is fired after the event registration occurs, after which the registration will be removed and no further events will be passed to the listener.

    Parameters

    • event: string

      The name of the event to add the listener for.

    • listener: ConvergenceEventListener<any>

      The listener callback to register.

    Returns ConvergenceEventEmitter<any>

    This object, in support of a fluent API.

remove

  • remove(keys: string[]): void
  • Parameters

    • keys: string[]

    Returns void

removeAllListeners

removeListener

removeListeners

set

  • set(state: Map<string, any>): void
  • Parameters

    • state: Map<string, any>

    Returns void

state

  • state(): Map<string, any>
  • Returns Map<string, any>

subscribe

unsubscribe

username

  • username(): string
  • Returns string