You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-22
Original file line number
Diff line number
Diff line change
@@ -12,20 +12,20 @@
12
12
1.[Sending your first message](#sending-your-first-message)
13
13
1.[Appendix](#appendix)
14
14
1.[Changelogs](#changelogs)
15
-
15
+
16
16
<br />
17
17
18
18
## Introduction
19
19
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.
21
21
22
22
### How it works
23
23
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.
25
25
26
26
### More about Sendbird Chat SDK for JavaScript
27
27
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).
29
29
30
30
<br />
31
31
@@ -51,7 +51,7 @@ This section shows you the prerequisites you need to check for using Sendbird Ch
51
51
Try building your Sendbird application with these two add-ons:
52
52
53
53
-[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.
55
55
56
56
<br />
57
57
@@ -61,7 +61,7 @@ This section gives you information you need to get started with Sendbird Chat SD
61
61
62
62
### Try the sample app
63
63
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.
@@ -171,21 +171,21 @@ Or download the latest Chat SDK for JavaScript from the following link if you do
171
171
172
172
<br />
173
173
174
-
## Sending your first message
174
+
## Sending your first message
175
175
176
176
Follow the step-by-step instructions below to authenticate and send your first message.
177
177
178
178
### Authentication
179
179
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.
181
181
182
182
### Step 1: Initialize the Chat SDK
183
183
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.
185
185
186
186
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.
187
187
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.
#### B. A combination of user ID and access token ID
212
+
#### B. A combination of user ID and access token ID
213
213
214
214
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.
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.
280
280
281
281
### XSS prevention
282
282
@@ -290,7 +290,7 @@ If you are using the [Immutable-js](https://immutable-js.github.io/immutable-js/
290
290
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.
@@ -325,10 +325,11 @@ The `sb.setErrorFirstCallback(false)` returns callbacks to their original parame
325
325
326
326
## Changelogs
327
327
328
-
## v3.0.141(DEC 21, 2020)
328
+
## v3.0.142(JAN 11, 2021)
329
329
330
330
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).
331
331
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.
0 commit comments