connectycube

Overview

ConnectyCube JavaScript SDK.

ConnectyCube is a messaging and video calling platform for iOS, Android and JavaScript apps.

Check our comprehensive guide for JavaScript SDK.

Features

• Messaging - first-class messaging API to build 1-1 and group chats, broadcast channels and so on. Different chat attachments are supported in the cloud.
• Video calling - peer-to-peer and group video calling up to 10 people based on modern WebRTC technologies. Various quality settings and audio/video codecs supported.
• Push notifications - never miss your chat messages with automatic push notifications to offline users. Also receive a push to all your devices when somebody calls you in a video chat.
• Authentication & Users - manage all the things related to user accounts handling, authentication, account data, password reminding etc. Integration with your own user base via external auth mechanisms.
• Chat bots - use chat bots to enable users to conversationally interact with your service or your product. Bots are fully automated services.

For more details check the ConnectyCube features page

Connect SDK

Simply connect the JS file as a normal script (UMD):

<script src="https://cdn.jsdelivr.net/npm/connectycube@x.x.x/dist/connectycube.min.js"></script>

where x.x.x is the desired JS SDK version (check for Releases page for all available versions).

Then a window scoped variable called ConnectyCube is created.

Or install the package as node_module:

npm install connectycube --save

And add script to HTML file from the 'node_modules' folder (as a relative path):

<script src="~/node_modules/connectycube/dist/connectycube.min.js"></script>

CommonJS:

const ConnectyCube = require('connectycube');

ES modules:

import ConnectyCube from 'connectycube';

Initialize the ConnectyCube SDK

const credentials = {
  appId: 21,
  authKey: 'A123210A-78AE-1DF9-9DD4-CC321AB6C189',
};

const config = {
  debug: { mode: 1 },
};

ConnectyCube.init(credentials, config);

You be able to create more then one client instance:

const cubeSender = new ConnectyCube.ConnectyCube();
const cubeReceiver = new ConnectyCube.ConnectyCube();

cubeSender.init(credentials, config);
cubeReceiver.init(credentials, config);

See an example of simple application based on Webpack build

Supported platforms

• Browser
• Node.js
• React Native
• Apache Cordova
• Electron

Contribution

See more information at CONTRIBUTING.md

License

Apache 2.0

Changelog

4.1.0

Added

• new API to get online users:

ConnectyCube.users.listOnline({limit?: number, offset?: number}): Promise<{users: array<User>}>;

Removed

• Contact List (XMPP Roster) was removed as deprecated;

Fixed

• Dialog types.