Cyxth

index

constructors

constructor

properties

appUrl
connected

methods

calls
chat
colab
connect
disconnect
on

Constructors

constructor

tsnew Cyxth (appUrl: string, plugins?: any[]) : Cyxth ;

create a new cyxth instance

tsimport Cyxth from '@cyxth/core';
import Colab from '@cyxth/colab';
import Calls from '@cyxth/calls';

const APP_URL = "my-app.apps.cyxth.com";
const cyxth = new Cyxth(APP_URL, [Colab,Calls])

Parameters

appUrl

cyxth app url from cyxth console https://app.cyxth.com

tsstring
plugins ?

| cyxth modules i.e Colab, Chat and Calls. you need atleast one of the core modules

tsany[]
Returns
tsCyxth

Properties

appUrl

cyxth app url from cyxth console https://app.cyxth.com

tsstring

connected

user connection status

tsboolean

Methods

calls

tscalls () : any ;

calls - video and audio call functionality

ts import Cyxth from '@cyxht/core';
 import Calls from '@cyxth/calls';

 const APP_URL = "my-app.apps.cyxth.com"; // app id
 const TOKEN = "e....."; // user auth token

 const cyxth = await new Cyxth(APP_URL, [Calls]).connect(TOKEN);
 const calls = cyxth.calls();
Returns

Calls

tsany

chat

tschat () : any ;

get a chat instance

ts import Cyxth from '@cyxht/core';
 import Chat from '@cyxth/chat';

 const APP_URL = "my-app.apps.cyxth.com"; // app id
 const TOKEN = "e....."; // user auth token

 const cyxth = await new Cyxth(APP_URL, [Chat]).connect(TOKEN);
 const chat = cyxth.chat();
Returns

Chat

tsany

colab

tscolab (wasmUrl?: string) : Promise<any> ;

get a colab instance

ts import Cyxth from '@cyxht/core';
 import Colab from '@cyxth/colab';

 const APP_URL = "my-app.apps.cyxth.com"; // app id
 const TOKEN = "e....."; // user auth token

 const cyxth = await new Cyxth(APP_URL, [Colab]).connect(TOKEN);
 const colab = await cyxth.colab("https://cdn.cyxth.com/colab_0.0.1.wasm");

Parameters

wasmUrl ?

colab-wasm binary url

tsstring
Returns

Colab

tsPromise<any>

connect

tsconnect (token: string | TokenData) : Promise<Cyxth> ;

connect to cyxth realtime servers

use your unique generated token

Parameters

token

user auth token

tsstring | TokenData
Returns

Cyxth

tsPromise<Cyxth>

disconnect

tsdisconnect () : boolean ;

disconeect from cyxth server

Returns

true

tsboolean

on

tson < K extends keyof CyxthEventMap > (event: K, handler:  (data: CyxthEventMap[K]) => any ) : void ;

listen for disconnect and error events

Parameters

event
tsK
handler

function

ts (data: CyxthEventMap[K]) : any ;
Returns
tsvoid