Sendbird JavaScript SDK
Sendbird provides the chat API and SDK for your app enabling real-time communication among your users.
Getting Started
bower package for Sendbird JavaScript SDK
bower install sendbird
npm module for Sendbird JavaScript SDK
npm install sendbird --save
Download for Sendbird JavaScript SDK if you wish to use it without a package manager.
NOTICE! You should also add axios library into the script
tag before the Sendbird library inclusion since v3.0.127
. You can host the library by your own, or utilize the CDN as the library refers to it. The below is an example.
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script src="/your-own-path-to-sendbird/Sendbird.min.js"></script>
TypeScript
Install via NPM and import like below in your TypeScript file:
import * as SendBird from "sendbird";
var sb = new SendBird({ appId: "APP_ID" });
If you have trouble importing Sendbird
, please check your tsconfig.json
file and change the value of "allowSyntheticDefaultImports"
to true
in compilerOptions
.
SyncManager
SyncManager
is a support add-on for Sendbird SDK. Major benefits of SyncManager
are,
- Local cache integrated: store channel/message data in local storage for fast view loading.
- Event-driven data handling: subscribe channel/message event like
insert
, update
, remove
at a single spot in order to apply data event to view.
Check out Basic Sample with SyncManager which is similar to Basic Sample but SyncManager
integrated. For more information about SyncManager
, please refer to SyncManager README.
v3.0.134(SEP 17, 2020)
If you want to check the record of other version, go to Change Log.
- Added
getTypingUsers()
in GroupChannel
.
- It returns the users even if the user is not in
members
. - Deprecated
getTypingMembers()
in GroupChanenl
.
- Set
url
as visible in FileMessage
object. - Set
profileUrl
as visible in User
object. - Bug-fix in error handling
- Improved stability.
License
Sendbird License