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: android-ui-kit-sample/README.md
+42-15
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,20 @@
1
1
# Overview
2
2
3
-
The QuickBlox UIKit for Android is a comprehensive user interface kit specifically designed for building chat applications. It provides a collection of pre-built components, modules, and utilities that simplify the process of creating chat applications.
3
+
The QuickBlox UIKit for Android is a comprehensive user interface kit specifically designed for building chat
4
+
applications. It provides a collection of pre-built components, modules, and utilities that simplify the process of
5
+
creating chat applications.
4
6
5
-
The main goal of the QuickBlox UIKit for Android is to offer developers a streamlined and efficient way to implement chat functionality within their Android applications.
7
+
The main goal of the QuickBlox UIKit for Android is to offer developers a streamlined and efficient way to implement
8
+
chat functionality within their Android applications.
6
9
7
-
The QuickBlox UIKit for Android offers modules that encapsulate complex chat functionalities, such as dialogs and chat management and real-time updates. These modules provide a simplified interface for integrating chat features into applications without the need for extensive knowledge of the underlying protocols or server-side infrastructure.
10
+
The QuickBlox UIKit for Android offers modules that encapsulate complex chat functionalities, such as dialogs and chat
11
+
management and real-time updates. These modules provide a simplified interface for integrating chat features into
12
+
applications without the need for extensive knowledge of the underlying protocols or server-side infrastructure.
8
13
9
14
# Features
10
15
11
16
QuickBlox UIKit for Android provides next functionality:
17
+
12
18
- List of dialogs
13
19
- Create dialog(Private or Group)
14
20
- Dialog screen
@@ -18,33 +24,44 @@ QuickBlox UIKit for Android provides next functionality:
18
24
19
25
# Send your first message
20
26
21
-
The QuickBlox UIKit for Android comprises a collection of pre-assembled UI components that enable effortless creation of an in-app chat equipped with all the necessary messaging functionalities. Our development kit encompasses light and dark themes, colors, and various other features. These components can be personalized to fashion an engaging messaging interface that reflects your brand's distinct identity.
27
+
The QuickBlox UIKit for Android comprises a collection of pre-assembled UI components that enable effortless creation of
28
+
an in-app chat equipped with all the necessary messaging functionalities. Our development kit encompasses light and dark
29
+
themes, colors, and various other features. These components can be personalized to fashion an engaging messaging
30
+
interface that reflects your brand's distinct identity.
22
31
23
-
The QuickBlox UIKit fully supports both private and group dialogs. To initiate the process of sending a message from the ground up using Java or Kotlin, please refer to the instructions provided in the guide below.
32
+
The QuickBlox UIKit fully supports both private and group dialogs. To initiate the process of sending a message from the
33
+
ground up using Java or Kotlin, please refer to the instructions provided in the guide below.
24
34
25
35
## Requirements
26
36
27
37
The minimum requirements for QuickBlox UIKit for Android are:
38
+
28
39
- Android 5.0 (API level 21) or higher
29
40
- Java 8 or higher
30
41
- Android Gradle plugin 4.0.1 or higher
31
42
32
43
## Before you begin
33
44
34
-
Register a new account following [this link](https://admin.quickblox.com/signup). Type in your email and password to sign in. You can also sign in with your Google or Github accounts.
45
+
Register a new account following [this link](https://admin.quickblox.com/signup). Type in your email and password to
46
+
sign in. You can also sign in with your Google or Github accounts.
35
47
Create the app clicking New app button.
36
48
Configure the app. Type in the information about your organization into corresponding fields and click Add button.
37
-
Go to Dashboard => YOUR_APP => Overview section and copy your Application ID, Authorization Key, Authorization Secret, and Account Key .
49
+
Go to Dashboard => YOUR_APP => Overview section and copy your Application ID, Authorization Key, Authorization Secret,
50
+
and Account Key .
38
51
39
52
## Install QuickBlox UIKit
40
53
41
54
There are several ways to install to QuickBlox UIKit from:
55
+
42
56
- Repository
43
57
- Local source
44
58
45
59
### Install QuickBlox UIKit from repository
60
+
46
61
To install QuickBlox UIKit to your app, import QuickBlox UIKit and QuickBlox SDK dependencies via build.gradle file.
47
-
Include reference to SDK repository in your **project-level build.gradle** file at the root directory or to **settings.gradle** file. Specify the URL of QuickBlox repository where the files are stored. Following this URL, gradle finds SDK artifacts.
62
+
Include reference to SDK repository in your **project-level build.gradle** file at the root directory or to **
63
+
settings.gradle** file. Specify the URL of QuickBlox repository where the files are stored. Following this URL, gradle
64
+
finds SDK artifacts.
48
65
49
66
```
50
67
repositories {
@@ -60,11 +77,12 @@ repositories {
60
77
}
61
78
```
62
79
63
-
Then need to add implementation of QuickBlox UIKit and QuickBlox SDK to dependencies in your module-level(App) **build.gradle** file.
80
+
Then need to add implementation of QuickBlox UIKit and QuickBlox SDK to dependencies in your module-level(App) **
To connect QuickBlox SDK to your app, import QuickBlox SDK dependencies via build.gradle file.
77
-
Include reference to SDK repository in your **project-level build.gradle** file at the root directory or to **settings.gradle** file. Specify the URL of QuickBlox repository where the files are stored. Following this URL, gradle finds SDK artifacts.
96
+
Include reference to SDK repository in your **project-level build.gradle** file at the root directory or to **
97
+
settings.gradle** file. Specify the URL of QuickBlox repository where the files are stored. Following this URL, gradle
98
+
finds SDK artifacts.
78
99
79
100
```
80
101
repositories {
@@ -86,7 +107,8 @@ repositories {
86
107
}
87
108
```
88
109
89
-
Then need to download the QuickBlox UIKit from the GitHub repository at [this link](https://github.com/QuickBlox/android-ui-kit) to include UIKit locally in your project.
110
+
Then need to download the QuickBlox UIKit from the GitHub repository
111
+
at [this link](https://github.com/QuickBlox/android-ui-kit) to include UIKit locally in your project.
90
112
91
113
Specify the path of the UIKit project in **settings.gradle** file.
92
114
@@ -105,8 +127,10 @@ dependencies {
105
127
106
128
## Init QuickBlox SDK
107
129
108
-
To init QuickBlox SDK you need to pass Application ID, Authorization Key, Authorization Secret, and Account Key to the init() method.
130
+
To init QuickBlox SDK you need to pass Application ID, Authorization Key, Authorization Secret, and Account Key to the
131
+
init() method.
109
132
How to get credentials is described in the [Before you begin](#before-you-begin) section.
Before sending your first message you need to authenticate users in the QuickBlox system. You can read more about different ways of authentication by [this link](https://docs.quickblox.com/docs/android-authentication).
145
+
Before sending your first message you need to authenticate users in the QuickBlox system. You can read more about
146
+
different ways of authentication by [this link](https://docs.quickblox.com/docs/android-authentication).
122
147
In our example we show how to authenticate user with login and password.
123
-
After successfully sign-in, you need to initialize the QuickBlox UIKit by invoke **init(applicationContext)** method of the **QuickBloxUiKit** and start Dialogs screen by invoke **show()** method of the **DialogActivity**.
148
+
After successfully sign-in, you need to initialize the QuickBlox UIKit by invoke **init(applicationContext)** method of
149
+
the **QuickBloxUiKit** and start Dialogs screen by invoke **show()** method of the **DialogActivity**.
0 commit comments