Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Convergence JavaScript Client API Documentation

Index

Modules

Classes

Enumerations

Interfaces

Type aliases

Object literals

Type aliases

ConvergenceEventListener

ConvergenceEventListener<T>: (event: T) => void

The ConvergenceEventListener type defines a function which takes a specific subclass of IConvergenceEvent as a single argument in order to receive fired events. Consumers can use the familiar Node style event registration methods (e.g. addListener, removeListener, on, off, once, etc.) or they can consume events as an observable stream using the events method.

param

The subclass of IConvergenceEvent that represents the fired event.

Type parameters

Type declaration

    • (event: T): void

    • Parameters

      • event: T

      Returns void

StringMapLike

StringMapLike<T>: Map<string, T> | {}

Represents a Javascript Map or Object literal.

Type parameters

  • T = any

Object literals

ConvergenceErrorCodes

ConvergenceErrorCodes: object

Some potential error codes in Convergence.

AUTHENTICATION_FAILED

AUTHENTICATION_FAILED: string = "authentication_failed"

CHAT_NOT_JOINED

CHAT_NOT_JOINED: string = "chat_not_joined"

CONNECTION_FAILED

CONNECTION_FAILED: string = "connection_failed"

MODEL_ALREADY_EXISTS

MODEL_ALREADY_EXISTS: string = "model_already_exists"

OFFLINE

OFFLINE: string = "offline"

REQUEST_TIMEOUT

REQUEST_TIMEOUT: string = "request_timeout"