Skip to content

Commit c12012a

Browse files
committed
v3.0.142
1 parent 70cbf5f commit c12012a

File tree

6 files changed

+485
-129
lines changed

6 files changed

+485
-129
lines changed

CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
## v3.0.142(JAN 11, 2021)
4+
5+
- Added `sendingStatus` to `AdminMessage`.
6+
- Updated TypeScript DefinitelyTyped file for Promise feature support.
7+
- Resolved security advisory on `axios` dependency.
8+
- Improved stability.
9+
310
## v3.0.141(DEC 21, 2020)
411

512
- Added a setter for `operators` in `OpenChannelParams`.

README.md

+23-22
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@
1212
1. [Sending your first message](#sending-your-first-message)
1313
1. [Appendix](#appendix)
1414
1. [Changelogs](#changelogs)
15-
15+
1616
<br />
1717

1818
## Introduction
1919

20-
Through Sendbird Chat SDK for Javascript, you can efficiently integrate real-time chat into your client app. On the client-side implementation, you can initialize, configure and build the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app. This **read.me** provides the Chat SDK’s structure, supplementary features, and the installation steps.
20+
Through Sendbird Chat SDK for Javascript, you can efficiently integrate real-time chat into your client app. On the client-side implementation, you can initialize, configure and build the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app. This **read.me** provides the Chat SDK’s structure, supplementary features, and the installation steps.
2121

2222
### How it works
2323

24-
It is simple to implement chat in your client app with the Chat SDK: a user logs in, sees a list of channels, selects or creates an [open channel](https://sendbird.com/docs/chat/v3/javascript/guides/open-channel#2-create-a-channel) or a [group channel](https://sendbird.com/docs/chat/v3/javascript/guides/group-channel#2-create-a-channel), and, through the use of the [channel event handlers](https://sendbird.com/docs/chat/v3/javascript/guides/event-handler), sends messages to the channel, while also receiving them from other users within the channel.
24+
It is simple to implement chat in your client app with the Chat SDK: a user logs in, sees a list of channels, selects or creates an [open channel](https://sendbird.com/docs/chat/v3/javascript/guides/open-channel#2-create-a-channel) or a [group channel](https://sendbird.com/docs/chat/v3/javascript/guides/group-channel#2-create-a-channel), and, through the use of the [channel event handlers](https://sendbird.com/docs/chat/v3/javascript/guides/event-handler), sends messages to the channel, while also receiving them from other users within the channel.
2525

2626
### More about Sendbird Chat SDK for JavaScript
2727

28-
Find out more about Sendbird Chat for JavaScript on [Chat SDK for JavaScript doc](https://sendbird.com/docs/chat/v3/javascript/getting-started/about-chat-sdk).
28+
Find out more about Sendbird Chat for JavaScript on [Chat SDK for JavaScript doc](https://sendbird.com/docs/chat/v3/javascript/getting-started/about-chat-sdk).
2929

3030
<br />
3131

@@ -51,7 +51,7 @@ This section shows you the prerequisites you need to check for using Sendbird Ch
5151
Try building your Sendbird application with these two add-ons:
5252

5353
- [Sendbird UIKit for JavaScript](https://sendbird.com/docs/uikit/v1/javascript/getting-started/about-uikit): a development kit with a user interface that enables an easy and fast integration of standard chat features into new or existing client apps.
54-
- [Sendbird SyncManager for JavaScript](https://sendbird.com/docs/syncmanager/v1/javascript/getting-started/about-syncmanager): the Chat SDK add-on that optimizes the user caching experience by interlinking the synchronization of the local data storage with the chat data in Sendbird server through an event-driven structure.
54+
- [Sendbird SyncManager for JavaScript](https://sendbird.com/docs/syncmanager/v1/javascript/getting-started/about-syncmanager): the Chat SDK add-on that optimizes the user caching experience by interlinking the synchronization of the local data storage with the chat data in Sendbird server through an event-driven structure.
5555

5656
<br />
5757

@@ -61,7 +61,7 @@ This section gives you information you need to get started with Sendbird Chat SD
6161

6262
### Try the sample app
6363

64-
The fastest way to test the Chat SDK is to build your chat app on top of our sample app. To create a project for the sample app, download the app from our GitHub repository. The link is down below.
64+
The fastest way to test the Chat SDK is to build your chat app on top of our sample app. To create a project for the sample app, download the app from our GitHub repository. The link is down below.
6565

6666
- https://github.com/sendbird/Sendbird-JavaScript
6767

@@ -73,9 +73,9 @@ $ git clone https://github.com/sendbird/SendBird-JavaScript
7373

7474
> **Note**: Find out more about Sendbird SDK for JavaScript samples on https://sample.sendbird.com
7575
76-
### Different sample projects
76+
### Different sample projects
7777

78-
For JavaScript, Sendbird supports a variety of sample projects. Their installation procedures are detailed as below:
78+
For JavaScript, Sendbird supports a variety of sample projects. Their installation procedures are detailed as below:
7979

8080
#### Run the web sample projects
8181

@@ -142,7 +142,7 @@ If you’re familiar with using external libraries or SDKs, installing the Chat
142142
$ npm install sendbird (request to npm server)
143143
```
144144

145-
Install via `Npm` and import like below in your `TypeScript` file.
145+
Install via `Npm` and import like below in your `TypeScript` file.
146146

147147
```bash
148148
import * as SendBird from "sendbird";
@@ -158,7 +158,7 @@ If you have trouble importing Sendbird, please check your `tsconfig.json` file a
158158
$ yarn add sendbird
159159
```
160160

161-
Or download the latest Chat SDK for JavaScript from the following link if you do not want to use package manager
161+
Or download the latest Chat SDK for JavaScript from the following link if you do not want to use package manager
162162

163163
- https://github.com/sendbird/Sendbird-SDK-JavaScript
164164

@@ -171,21 +171,21 @@ Or download the latest Chat SDK for JavaScript from the following link if you do
171171

172172
<br />
173173

174-
## Sending your first message
174+
## Sending your first message
175175

176176
Follow the step-by-step instructions below to authenticate and send your first message.
177177

178178
### Authentication
179179

180-
To use the features of the Chat SDK in your client app, a `sb` instance must be initiated in each client app before user authentication with Sendbird server. These instances communicate and interact with the server based on an authenticated user account, allowing for the client app to use the Chat SDK features.
180+
To use the features of the Chat SDK in your client app, a `sb` instance must be initiated in each client app before user authentication with Sendbird server. These instances communicate and interact with the server based on an authenticated user account, allowing for the client app to use the Chat SDK features.
181181

182182
### Step 1: Initialize the Chat SDK
183183

184-
You need to initialize a `sb` instance before authentication. Initialization binds the Chat SDK to Javascript’s context which allows the Chat SDK to respond to connection and state changes and also enables client apps to use the Chat SDK features.
184+
You need to initialize a `sb` instance before authentication. Initialization binds the Chat SDK to Javascript’s context which allows the Chat SDK to respond to connection and state changes and also enables client apps to use the Chat SDK features.
185185

186186
To initialize a `Sendbird` instance, pass the `App_ID` of your Sendbird application in the dashboard as an argument to a parameter in the `new Sendbird()` method. As the `new SendBird()` can only be a single instance, call it only a single time across your Javascript client app. Typically, initialization is implemented in the user login screen.
187187

188-
> **Note**: It is recommended to initialize the Chat SDK at the top of your Javascript file.
188+
> **Note**: It is recommended to initialize the Chat SDK at the top of your Javascript file.
189189
190190
```javascript
191191
var sb = new SendBird({appId: APP_ID});
@@ -209,7 +209,7 @@ sb.connect(USER_ID, function(user, error) {
209209
});
210210
```
211211

212-
#### B. A combination of user ID and access token ID
212+
#### B. A combination of user ID and access token ID
213213

214214
Sendbird prefers that you pass the APP ID through the use of a token, as it ensures privacy for the users. Create a user along with their access token, or issue an access token for an existing user. Once an access token is issued, a user is required to provide the access token in the `sb.connect()` method which is used for logging in.
215215

@@ -251,7 +251,7 @@ sb.OpenChannel.getChannel(CHANNEL_URL, function(openChannel, error) {
251251
if (error) {
252252
return;
253253
}
254-
254+
255255
openChannel.enter(function(response, error) {
256256
if (error) {
257257
return;
@@ -276,7 +276,7 @@ openChannel.sendUserMessage(MESSAGE, DATA, CUSTOM_TYPE, function(message, error)
276276

277277
## Appendix
278278

279-
Sendbird wants customers to be confident that Chat SDK will be useful, work well, and fit within their needs. Thus, we have compiled a couple of optional guidelines. Take a few minutes to read and apply them at your convenience.
279+
Sendbird wants customers to be confident that Chat SDK will be useful, work well, and fit within their needs. Thus, we have compiled a couple of optional guidelines. Take a few minutes to read and apply them at your convenience.
280280

281281
### XSS prevention
282282

@@ -290,7 +290,7 @@ If you are using the [Immutable-js](https://immutable-js.github.io/immutable-js/
290290
So you can call the functions of Sendbird objects because the `fromJS()` method returns internal objects. But if you use a `Map` function, you can't call any functions of a Sendbird object.
291291

292292
```javascript
293-
var userIds = ['John', 'Harry'];
293+
var userIds = ['John', 'Harry'];
294294

295295
sb.GroupChannel.createChannelWithUserIds(userIds, false, NAME, COVER_URL, DATA, function(groupChannel, error) {
296296
if (error) {
@@ -325,10 +325,11 @@ The `sb.setErrorFirstCallback(false)` returns callbacks to their original parame
325325

326326
## Changelogs
327327

328-
## v3.0.141(DEC 21, 2020)
328+
## v3.0.142(JAN 11, 2021)
329329

330330
If you want to check the record of other versions, go to [Change Log](https://github.com/sendbird/Sendbird-SDK-JavaScript/blob/master/CHANGELOG.md).
331331

332-
- Added a setter for `operators` in `OpenChannelParams`.
333-
- Added `getLogLevel()` and `setLogLevel()` in `SendBird`.
334-
- Improved stability.
332+
- Added `sendingStatus` to `AdminMessage`.
333+
- Updated TypeScript DefinitelyTyped file for Promise feature support.
334+
- Resolved security advisory on `axios` dependency.
335+
- Improved stability.

0 commit comments

Comments
 (0)