npm

Need private packages and team management tools?Check out npm Orgs. »

connectycube

1.8.1 • Public • Published

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

Browser

Simply connect the JS file as a normal script:

<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 NPM 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>

and you're ready to initialize the ConnectyCube SDK:

const credentials = {
    appId: 21,
    authKey: 'hhf87hfushuiwef',
    authSecret: 'jjsdf898hfsdfk'
};
 
const config = {
    debug: { mode: 1 }
};
 
ConnectyCube.init(credentials, config);

You be able to create more then one client instance:

const cudeSender = new ConnectyCube.ConnectyCube();
const cudeReceiver = new ConnectyCube.ConnectyCube();
 
cudeSender.init(credentials, config);
cudeReceiver.init(credentials, config);

See an example of simple application based on Webpack build

Node.js/NPM, Native Script integration

Simply install the package in a normal way:

npm install connectycube --save

and you're ready to go:

var cubeClient = require('connectycube');

React Native integration

Simply install the package in a normal way:

npm install connectycube-reactnative --save

and you're ready to go:

import { ConnectyCube } from 'connectycube-reactnative'
 
const CB = new ConnectyCube()

Supported platforms

  • Browser
  • Node.js
  • NativeScript
  • ReactNative

Contribution

See more information at CONTRIBUTING.md

License

Apache 2.0

install

npm i connectycube

Downloadsweekly downloads

93

version

1.8.1

license

Apache 2.0

repository

Gitgitlab

last publish

collaborators

  • avatar
Report a vulnerability