Options
All
  • Public
  • Public/Protected
  • All
Menu

Convergence JavaScript Client

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ChatChannelMembership

ChatChannelMembership: "public" | "private"

ChatChannelType

ChatChannelType: "direct" | "group" | "room"

ChatPermission

ChatPermission: "create_chat_channel" | "remove_chat_channel" | "join_chat_channel" | "leave_chat_channel" | "add_chat_user" | "remove_chat_user" | "set_chat_name" | "set_topic" | "manage_chat_permissions"

ConvergenceEventListener

ConvergenceEventListener: function

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 declaration

    • (event: T): void
    • Parameters

      • event: T

      Returns void

EventKey

EventKey: string | number

ModelDataInitializer

ModelDataInitializer: object | function

Path

Path: PathElement[]

PathElement

PathElement: string | number

SimpleEventListener

SimpleEventListener: function

Type declaration

    • (...args: any[]): void
    • Parameters

      • Rest ...args: any[]

      Returns void

StringMapLike

StringMapLike: Map<string, any> | object

WebSocketFactory

WebSocketFactory: function

Type declaration

    • (url: string): WebSocket
    • Parameters

      • url: string

      Returns WebSocket

Variables

Const ObservableArrayEventConstants

ObservableArrayEventConstants: ObservableArrayEvents = Object.assign({INSERT: "insert",REMOVE: "remove",SET: "set",REORDER: "reorder"},ObservableElementEventConstants)

Const ObservableNumberEventConstants

ObservableNumberEventConstants: ObservableNumberEvents = Object.assign({DELTA: "delta"},ObservableElementEventConstants)

Const ObservableObjectEventConstants

ObservableObjectEventConstants: ObservableObjectEvents = Object.assign({SET: "set",REMOVE: "remove"},ObservableElementEventConstants)

Const ObservableStringEventConstants

ObservableStringEventConstants: ObservableStringEvents = Object.assign({INSERT: "insert",REMOVE: "remove"},ObservableElementEventConstants)

Const connect

connect: connect = Convergence.connect

Const connectAnonymously

connectAnonymously: connectAnonymously = Convergence.connectAnonymously

Const connectWithJwt

connectWithJwt: connectWithJwt = Convergence.connectWithJwt

Const reconnect

reconnect: reconnect = Convergence.reconnect

Object literals

Const ChatChannelTypes

ChatChannelTypes: object

DIRECT

DIRECT: string = "direct"

GROUP

GROUP: string = "group"

ROOM

ROOM: string = "room"

Const ObservableElementEventConstants

ObservableElementEventConstants: object

DETACHED

DETACHED: string = "detached"

MODEL_CHANGED

MODEL_CHANGED: string = "model_changed"

REFERENCE

REFERENCE: string = "reference"

VALUE

VALUE: string = "value"

Const ObservableModelEventConstants

ObservableModelEventConstants: object

CLOSED

CLOSED: string = "closed"

DELETED

DELETED: string = "deleted"

VERSION_CHANGED

VERSION_CHANGED: string = "version_changed"

Const UserFields

UserFields: object

DISPLAY_NAME

DISPLAY_NAME: string = "displayName"

EMAIL

EMAIL: string = "email"

FIRST_NAME

FIRST_NAME: string = "firstName"

LAST_NAME

LAST_NAME: string = "lastName"

USERNAME

USERNAME: string = "username"