QuickBlox JavaScript SDK

The QuickBlox JavaScript SDK provides a JavaScript library making it even easier to access the QuickBlox cloud communication backend platform.

QuickBlox is a suite of communication features & data services (APIs, SDKs, code samples, admin panel, tutorials) which help digital agencies, mobile developers and publishers to add great communication functionality to smartphone applications like in Skype, WhatsApp, Viber.

Install

Dependencies for browser

For the library to work, you need to include either jQuery or Zepto in your html before quickblox.min.js, like so:

For correct work of JS SDK you must include the library in your html before quickblox.min.js, like so:

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/quickblox/2.5.3/quickblox.min.js"></script>

Begin with version 2.5.0 no dependencies for work correctly is not needed.

Bower and RequireJS

If you use bower package manager for your project, you can install JS SDK through bower:

bower install quickblox --save

When you use RequireJS, you are able to use quickblox as AMD module. SDK supports UMD (Universal Module Definition) pattern for JavaScript modules. So it is possible to use SDK everywhere (as browser global variable, with AMD module loader like RequireJS or as CommonJS module for Node.js environment).

Node.js and NPM integration

Also you can use QuickBlox JavaScript SDK with server-side applications on NodeJS through the native node package. Just install the package in your application project like that:

npm install quickblox --save

And you're ready to go:

var QB = require('quickblox');

// OR to create many QB instances
var QuickBlox = require('quickblox').QuickBlox;
var QB1 = new QuickBlox();
var QB2 = new QuickBlox();

Download ZIP archive

QuickBlox JavaScript SDK, zip archive

Browsers support

IE	Firefox	Chrome	Safari	Opera	Node.js
10+	30+	30+	7.1+	23+	4+

Documentation

You can look at it here https://quickblox.com/developers/Javascript

Questions and feedback

Please raise questions, requests for help etc. via https://stackoverflow.com/questions/tagged/quickblox

Feedback and suggestions for improvement always welcome :)

How to contribute

See more information at contributing.md

License

Apache 2.0

ruffin-- / quickblox-javascript-sdk Goto Github PK