Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatService

Hierarchy

Index

Properties

Static Events

Events: ChatServiceEvents = Events

Methods

addListener

create

direct

events

  • 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<IChatEvent>

    An Observable stream of all events emitted by this object.

exists

  • exists(channelId: string): Promise<boolean>
  • Parameters

    • channelId: string

    Returns Promise<boolean>

get

  • Parameters

    • channelId: string

    Returns Promise<ChatChannel>

join

  • Parameters

    • channelId: string

    Returns Promise<ChatChannel>

joined

leave

  • leave(channelId: string): Promise<void>
  • Parameters

    • channelId: string

    Returns Promise<void>

off

on

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

    Returns ConvergenceEventEmitter<IChatEvent>

    This object, in support of a fluent API.

permissions

remove

  • remove(channelId: string): Promise<void>
  • Parameters

    • channelId: string

    Returns Promise<void>

removeAllListeners

removeListener

removeListeners

search

session