Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatChannel

Hierarchy

Index

Properties

Static Events

Events: ChatChannelEvents = Events

Methods

addListener

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.

getHistory

info

isJoined

  • isJoined(): boolean
  • Returns boolean

markSeen

  • markSeen(eventNumber: number): Promise<void>
  • Parameters

    • eventNumber: number

    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.

removeAllListeners

removeListener

removeListeners

send

  • send(message: string): Promise<void>
  • Parameters

    • message: string

    Returns Promise<void>

session

setName

  • setName(name: string): Promise<void>
  • Parameters

    • name: string

    Returns Promise<void>

setTopic

  • setTopic(topic: string): Promise<void>
  • Parameters

    • topic: string

    Returns Promise<void>