ezajil-js-sdk
v3.0.0
Published
ezajil javascript SDK - The Real-Time Chat and Presence Tracking Solution
Downloads
6
Maintainers
Readme
Introduction
Welcome to the JavaScript SDK documentation. This guide will walk you through the integration process to add chat and presence monitoring capabilities to your application using our SDK.
Key Features
- Real-time messaging within chatrooms.
- Online presence tracking to see when users are online, or offline.
- Support for both single and group chatrooms.
- File uploads within messages.
- Message receipts including user typing, message delivered, and message read notifications.
- Extensive event handling to react to chat activities in real-time.
Getting Started
Prerequisites
Before integrating ezajil-js-sdk
into your project, ensure you have:
- Modern web browser with JavaScript enabled (e.g., Google Chrome, Mozilla Firefox, Safari, Edge).
- Support for ES6 (ECMAScript 2015) or later for optimal SDK functionality.
- An account registered on our platform
Obtaining an API Key
Sign up on our platform and navigate to ezajil dashboard to create a new project. Upon creation, you will be provided with an endpoint and an API key required for authenticating your application.
Installation
To install the SDK in your project, run the following command in your project directory:
npm install ezajil-js-sdk --save
For a comprehensive guide on how to use this library, please visit https://ezajil.io/documentation/javascript for detailed documentation and examples.