add app-kotlin

README.md

@@ -1,44 +1,51 @@
 # Agora chat demo
 
-This repository will help you learn how to use Agora chat SDK to implement a simple chat android application, like whatsapp or wechat.
+This repository will help you learn how to use Agora chat SDK to implement a simple android chat app, like whatsapp or wechat.
 
 With this sample app, you can:
 
-- Login chat server
+- Log in to the chat server
 - Start a chat
-- Manage conversation list
+- Manage the conversation list
 - Add contacts
 - Join group chats
-- Join chat rooms
-- Add your contacts to your blacklist
-- Send various types of messages, Such as: text, expression, picture, voice, file and so on
-- Logout
+- Add your contacts to your block list
+- Send various types of messages, such as text, emoji, image, voice and file messages
+- Log out of the chat server
 
 ## Prerequisites
-* Make sure you have made the preparations mentioned in the [Agora Chat SDK quickstart](https://docs.agora.io/en/agora-chat/get-started/get-started-sdk?platform=android).
-* Prepare the development environment:
-    * Java Development Kit (JDK)
-    * Android Studio 3.6 or later
+
+- Make sure you have made the preparations mentioned in the [Agora Chat SDK quickstart](https://docs.agora.io/en/agora-chat/get-started/get-started-sdk?platform=android).
+- Prepare the development environment:
+  - Java Development Kit (JDK)
+  - Android Studio Flamingo | 2022.2.1 or later
+
 ## Run the sample project
 
-Follow these steps to run the sample project:\
-### 1. Clone the repository to your local machine.
+Follow these steps to run the sample project:
+
+### 1. Clone the repository to your local device
+
 ```java
     git clone git@github.com:AgoraIO-Usecase/AgoraChat-android.git
 ```
 
-### 2. Open the Android project with Android Studio.
+### 2. Open the Android project with Android Studio
 
-### 3. Configure keys.
-Set your appkey applied from [Agora Developer Console](https://console.agora.io/) before calling ChatClient#init().
-```java
-ChatOptions options = new ChatOptions();
-// Set your appkey
-options.setAppKey("Your appkey");
-...
-//initialization
-ChatClient.getInstance().init(applicationContext, options);
+### 3. Configure keys
+
+Set your appkey obtained from the [Agora Console](https://console.agora.io/) before calling ChatClient#init().
+
+```kotlin
+val chatOptions = ChatOptions().apply {
+    // Set your appkey
+    appKey = "Your appkey"
+    ...
+}
+// initialization
+ChatClient.getInstance().init(context, chatOptions)
 ```
+
 For details, see the [prerequisites](https://docs.agora.io/en/agora-chat/get-started/get-started-sdk?platform=android) in Agora Chat SDK Guide.
 
 ## Precautions
@@ -50,8 +57,10 @@ For details, see the [prerequisites](https://docs.agora.io/en/agora-chat/get-sta
     ```
 
 ## Contact Us
+
 - You can find full API document at [Document Center](https://docs.agora.io/en/agora-chat/overview/product-overview?platform=android)
 - You can file bugs about this demo at [issue](https://github.com/AgoraIO-Usecase/AgoraChat-android/issues)
 
 ## License
+
 The MIT License (MIT).

app-kotlin/.gitignore

@@ -0,0 +1,2 @@
+/build
+/src/google-services.json

app-kotlin/README.md

@@ -0,0 +1,292 @@
+# 快速开始
+
+利用环信单群聊 UIKit，你可以轻松实现单群和群聊。本文介绍如何快速实现在单聊会话中发送消息。
+
+## 前提条件
+
+### 开发环境要求
+
+- Android Studio 4.0 及以上
+- Gradle 4.10.x 及以上
+- targetVersion 26 及以上
+- Android SDK API 21 及以上
+- JDK 11 及以上
+
+## 项目准备
+
+下面将介绍将单群聊 UIKit 引入项目中的必要环境配置。
+
+1. 用 **Android Studio** 创建一个[新的项目](https://developer.android.com/studio/projects/create-project)，在 **Phone and Tablet** 标签选择 **Empty Views Activity**，**Minimum SDK** 选择 **API 21: Android 5.0 (Lollipop)**，**Language** 选择 **Kotlin**。创建项目成功后，请确保项目同步完成。
+
+2. 检查工程是否引入 **mavenCentral** 仓库。
+
+    a. Gradle 7.0 之前
+    在 `/Gradle Scripts/build.gradle.kts(Project: <projectname>)`文件内，检查是否有 **mavenCentral** 仓库。
+    ```kotlin
+    buildscript {
+       repositories {
+           mavenCentral()
+       }
+    }
+    ```
+    b. Gradle 7.0 之后
+    在 `/Gradle Scripts/settings.gradle.kts(Project Settings)`文件内，检查是否有 **mavenCentral** 仓库。
+    ```kotlin
+    dependencyResolutionManagement {
+        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
+        repositories {
+            mavenCentral()
+        }
+    }
+    ```
+3. 在项目中引入单群聊 UIKit
+
+从 GitHub 获取[单群聊 UIKit](https://github.com/easemob/chatuikit-android) 源码，按照下面的方式集成：
+
+- 在根目录 `settings.gradle.kts` 文件（/Gradle Scripts/settings.gradle.kts）中添加如下代码：
+
+```kotlin
+include(":ease-im-kit")
+project(":ease-im-kit").projectDir = File("../chatuikit-android/ease-im-kit")
+```
+
+- 在 app 的 `build.gradle.kts` 文件（/Gradle Scripts/build.gradle）中添加如下代码：
+
+```kotlin
+//chatuikit-android
+implementation(project(mapOf("path" to ":ease-im-kit")))
+```
+
+4. 防止代码混淆
+
+在 `/Gradle Scripts/proguard-rules.pro` 文件中添加如下代码：
+
+	```
+	-keep class com.hyphenate.** {*;}
+    -dontwarn  com.hyphenate.**
+	```
+## 实现单聊发消息
+
+这部分将介绍如何通过单群聊 UIKit 一步一步的实现单聊发送消息的。
+
+### 创建页面相关
+
+1. 打开 `app/res/values/strings.xml` 文件，并替换为如下内容：
+
+```xml
+<resources>
+    <string name="app_name">quickstart</string>
+
+    <string name="app_key">[您申请的appkey]</string>
+</resources>
+
+```
+这里需要注意的是，需要将 **app_key** 替换为您申请的 appkey。
+
+2. 打开 `app/res/layout/activity_main.xml` 文件，并替换为如下内容：
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:orientation="vertical"
+    tools:context=".MainActivity">
+
+    <EditText
+        android:id="@+id/et_userId"
+        android:layout_width="match_parent"
+        android:layout_height="50dp"
+        android:layout_margin="20dp"
+        android:hint="UserId"/>
+
+    <EditText
+        android:id="@+id/et_password"
+        android:layout_width="match_parent"
+        android:layout_height="50dp"
+        android:layout_margin="20dp"
+        android:hint="Password"/>
+
+    <Button
+        android:id="@+id/btn_login"
+        android:layout_width="match_parent"
+        android:layout_height="50dp"
+        android:layout_margin="20dp"
+        android:onClick="login"
+        android:text="Login"/>
+
+    <Button
+        android:id="@+id/btn_logout"
+        android:layout_width="match_parent"
+        android:layout_height="50dp"
+        android:layout_margin="20dp"
+        android:onClick="logout"
+        android:text="Logout"/>
+
+    <EditText
+        android:id="@+id/et_peerId"
+        android:layout_width="match_parent"
+        android:layout_height="50dp"
+        android:layout_margin="20dp"
+        android:hint="PeerId"/>
+
+    <Button
+        android:id="@+id/btn_chat"
+        android:layout_width="match_parent"
+        android:layout_height="50dp"
+        android:layout_margin="20dp"
+        android:onClick="startChat"
+        android:text="Start Chat"/>
+
+</LinearLayout>
+```
+
+### 实现代码逻辑
+
+1. 实现登录和退出页面。
+
+打开 `MainActivity` 文件，并替换为如下代码：
+
+```kotlin
+package com.easemob.quickstart
+
+import android.content.Context
+import androidx.appcompat.app.AppCompatActivity
+import android.os.Bundle
+import android.view.View
+import android.widget.Toast
+import com.easemob.quickstart.databinding.ActivityMainBinding
+import com.hyphenate.easeui.EaseIM
+import com.hyphenate.easeui.common.ChatConnectionListener
+import com.hyphenate.easeui.common.ChatLog
+import com.hyphenate.easeui.common.ChatOptions
+import com.hyphenate.easeui.feature.messages.EaseChatType
+import com.hyphenate.easeui.feature.messages.activities.EaseChatActivity
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+
+class MainActivity : AppCompatActivity(), ChatConnectionListener {
+    private val binding: ActivityMainBinding by lazy { ActivityMainBinding.inflate(layoutInflater) }
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(binding.root)
+        initSDK()
+        initListener()
+    }
+
+    private fun initSDK() {
+        val appkey = getString(R.string.app_key)
+        if (appkey.isNullOrEmpty()) {
+            showToast("You should set your AppKey first!")
+            ChatLog.e(TAG, "You should set your AppKey first!")
+            return
+        }
+        ChatOptions().apply {
+            // Set your own appkey here
+            this.appKey = appkey
+            // Set not to log in automatically
+            this.autoLogin = false
+            // Set whether confirmation of delivery is required by the recipient. Default: false
+            this.requireDeliveryAck = true
+        }.let {
+            EaseIM.init(applicationContext, it)
+        }
+    }
+
+    private fun initListener() {
+        EaseIM.subscribeConnectionDelegates(this)
+    }
+
+    fun login(view: View) {
+        val username = binding.etUserId.text.toString().trim()
+        val password = binding.etPassword.text.toString().trim()
+        if (username.isEmpty() || password.isEmpty()) {
+            showToast("Username or password cannot be empty!")
+            ChatLog.e(TAG, "Username or password cannot be empty!")
+            return
+        }
+        if (!EaseIM.isInited()) {
+            showToast("Please init first!")
+            ChatLog.e(TAG, "Please init first!")
+            return
+        }
+        EaseIM.login(username, password
+            , onSuccess = {
+                showToast("Login successfully!")
+                ChatLog.e(TAG, "Login successfully!")
+            }, onError = { code, message ->
+                showToast("Login failed: $message")
+                ChatLog.e(TAG, "Login failed: $message")
+            }
+        )
+    }
+
+    fun logout(view: View) {
+        if (!EaseIM.isInited()) {
+            showToast("Please init first!")
+            ChatLog.e(TAG, "Please init first!")
+            return
+        }
+        EaseIM.logout(false
+            , onSuccess = {
+                showToast("Logout successfully!")
+                ChatLog.e(TAG, "Logout successfully!")
+            }
+        )
+    }
+
+    fun startChat(view: View) {
+        val username = binding.etPeerId.text.toString().trim()
+        if (username.isEmpty()) {
+            showToast("Peer id cannot be empty!")
+            ChatLog.e(TAG, "Peer id cannot be empty!")
+            return
+        }
+        if (!EaseIM.isLoggedIn()) {
+            showToast("Please login first!")
+            ChatLog.e(TAG, "Please login first!")
+            return
+        }
+        EaseChatActivity.actionStart(this, username, EaseChatType.SINGLE_CHAT)
+    }
+
+    override fun onConnected() {}
+
+    override fun onDisconnected(errorCode: Int) {}
+
+    override fun onLogout(errorCode: Int, info: String?) {
+        super.onLogout(errorCode, info)
+        showToast("You have been logged out, please log in again!")
+        ChatLog.e(TAG, "")
+    }
+
+    override fun onDestroy() {
+        super.onDestroy()
+        EaseIM.unsubscribeConnectionDelegates(this)
+    }
+
+    companion object {
+        private const val TAG = "MainActivity"
+    }
+}
+
+fun Context.showToast(msg: String) {
+    CoroutineScope(Dispatchers.Main).launch {
+        Toast.makeText(this@showToast, msg, Toast.LENGTH_SHORT).show()
+    }
+}
+```
+
+2. 点击 `Sync Project with Gradle Files` 同步工程。现在可以测试你的应用了。
+
+## 测试应用
+
+1. 在 Android Studio 中，点击 `Run ‘app’` 按钮，将应用运行到您的设备或者模拟器上。
+
+2. 输入用户名和密码，点击 `Login` 按钮进行登录，登录成功或者失败有 `Toast` 提示，或者通过 Logcat 查看。
+
+3. 在另一台设备或者模拟器上登录另一个账号。
+
+4. 两台设别或者模拟器分别输入对方的账号，并点击 `Start Chat` 按钮，进入聊天页面。现在你可以在两个账号间进行聊天了。