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.com JavaScript SDK

  bower install sendbird  

npm module for SendBird.com JavaScript SDK

  npm install sendbird --save  

download for SendBird.com JavaScript SDK

TypeScript

Install via NPM and import like below in your TypeScript file:

import * as SendBird from 'sendbird';
var sb = new SendBird({'appId': 'APP_ID'});
// do something...

If you have trouble importing SendBird, please check your tsconfig.json file and change the value of "allowSyntheticDefaultImports" to true in compilerOptions.

Sample

• Basic Sample using Sendbird SDK. download
• Widget Sample using Sendbird SDK. download
• LiveChat Sample using Sendbird SDK. download

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 same as Basic Sample with SyncManager integrated.
For more information about SyncManager, please refer to SyncManager README.

Documentation

v3.0.89(NOV 22, 2018)

If you want to check the record of other version, go to Change Log.

• Added createDistinctChannelIfNotExist() in GroupChannel.
  • It creates distinct channel and gets the channel with isCreated flag which represents whether the channel is actually created or not.
• Added getMessageChangeLogsByTimestamp() in SendBird.
  • It retrieves message change logs since the given timestamp.
• Added hiddenState property in GroupChannel to get channel's hidden state.
  • unhidden: It's not hidden channel.
  • hidden-allow-auto-unhide: It's hidden channel which is automatically unhidden when new message comes in.
  • hidden-prevent-auto-unhide: It's hidden channel which is not unhidden when new message comes in.
• Added allowAutoUnhide as the second parameter into hide() to allow automatic unhide on new message.
• Added unhide() in GroupChannel to manually unhide the channel.
• Added hiddenChannelFilter in GroupChannelListQuery to filter by hiddenState.
  • unhidden_only: Get all unhidden channels. (default)
  • hidden_only: Get all hidden channels which hiddenState is hidden_allow_auto_unhide or hidden_prevent_auto_unhide.
  • hidden_allow_auto_unhide: Get channels which hiddenState is hidden_allow_auto_unhide.
  • hidden_prevent_auto_unhide: Get channels which hiddenState is hidden_prevent_auto_unhide.

Change Log

License

SendBird License