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: samples/chat/README.md
+41-12Lines changed: 41 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -3,24 +3,53 @@ QuickBlox JS Sample Chat
3
3
4
4
This is a code sample for [QuickBlox](http://quickblox.com/) platform. It is a great way for developers using QuickBlox platform to learn how to integrate private and group chat, add text and image attachments sending into your application.
5
5
6
-
# Credentials
6
+
# Get application credentials
7
+
[](#get-application-credentials)
7
8
8
-
Welcome to QuickBlox [Credentials](https://quickblox.com/developers/5_Minute_Guide), where you can get your credentials in just 5 minutes! All you need is to:
9
+
QuickBlox application includes everything that brings messaging right
10
+
into your application - chat, video calling, users, push notifications,
11
+
etc. To create a QuickBlox application, follow the steps below:
9
12
10
-
1. Register a free QuickBlox account and add your App there.
11
-
2. Update credentials in your application code.[Chat](https://quickblox.com/developers/5_Minute_Guide#Update_authentication_credentials_3)
13
+
1. Register a new account following [this
14
+
link](https://admin.quickblox.com/signup). Type in your email and
15
+
password to sign in. You can also sign in with your Google or Github
16
+
accounts.
17
+
2. Create the app clicking **New app** button.
18
+
3. Configure the app. Type in the information about your organization
19
+
into corresponding fields and click **Add** button.
20
+
4. Go to **Dashboard =\>*YOUR\_APP* =\> Overview** section and copy
21
+
your **Application ID**, **Authorization Key**, **Authorization
22
+
Secret**, and **Account Key**.
12
23
13
-
# Chat Sample
24
+
# Run chat sample
14
25
15
-
This Sample demonstrates how to work with [Chat](https://quickblox.com/developers/Web_XMPP_Chat_Sample#Guide:_Getting_Started_with_Chat_API) QuickBlox module.
26
+
To run a code sample, follow the steps below:
16
27
17
-
It allows:
28
+
1. Download the code sample.
29
+
2.[Get application credentials](#get-application-credentials) and get appId, authKey, authSecret, and accountKey.
30
+
3. Put these values in file **QBconfig.js** following **samples =\>
31
+
chat =\> js** directory.
18
32
19
-
1. Authenticate with Quickblox Chat and REST.
20
-
2. Receive and display list of dialogs.
21
-
3. Modify dialog by adding occupants.
22
-
4. Real-time chat messaging and attachment's handling.
33
+
JavaScript
34
+
35
+
var QBconfig = {
36
+
credentials: {
37
+
appId: '',
38
+
authKey: '',
39
+
authSecret: '',
40
+
accountKey: ''
41
+
}
42
+
}
43
+
44
+
4. Run the code sample by opening **index.html** file.
45
+
46
+
# Requirements
47
+
[](#requirements)
48
+
49
+
The minimum requirements for QuickBlox JavaScript SDK are:
50
+
51
+
- JavaScript es5.
23
52
24
53
# Documentation
25
54
26
-
Original sample description & setup guide - [JS Chat Sample](https://quickblox.com/developers/Web_XMPP_Chat_Sample#Guide:_Getting_Started_with_Chat_API)
55
+
Sample documentation is available [here](https://quickblox.com/developers/Web_XMPP_Chat_Sample#Guide:_Getting_Started_with_Chat_API).
0 commit comments