即时通信 IM Android

概述
Android 平台提供了完整的 AI 聊天机器人功能支持，包括：
智能机器人对话
流式消息渲染 
思考状态显示
中断对话功能
经典版 
简约版
﻿
﻿
﻿
﻿
﻿
﻿
开发环境要求
Android Studio-Giraffe 
Gradle-7.2
Android Gradle Plugin Version-7.0.0
Java 11
kotlin-gradle-plugin-1.5.31
集成 AI 聊天机器人
说明：
1. 除了 AI 聊天机器人外，还需集成其他 TUIKit 功能，请参见 集成 TUIKit。
2. AI 聊天机器人功能目前免费内测中（若后续收费会提前通知），上限可创建20个 AI 聊天机器人，如需提升上限可联系我们。
步骤1：创建 AI 聊天机器人
集成 AI 聊天机器人组件之前，请先在控制台 创建 AI 聊天机器人。
步骤2：集成源码
1. 从 GitHub 下载 TUIKit 源码。使 TUIKit 文件夹跟自己的工程文件夹同级，例如：
﻿
2. 在 settings.gradle 中添加 TUIChat 组件：
// 引入内部组件通信模块 (必要模块)
include ':tuicore'
project(':tuicore').projectDir = new File(settingsDir, '../TUIKit/TUICore/tuicore')
﻿
// 引入 IM 组件公共模块（必要模块）
include ':timcommon'
project(':timcommon').projectDir = new File(settingsDir, '../TUIKit/TIMCommon/timcommon')
﻿
// 引入聊天功能模块 (基础功能模块)
include ':tuichat'
project(':tuichat').projectDir = new File(settingsDir, '../TUIKit/TUIChat/tuichat')
3. 在 App 模块中添加 TUIChat 依赖：
api project(':tuichat')
4. ﻿添加 Maven 仓库 和 Kotlin 支持，在 root 工程的 build.gradle 文件（与 settings.gradle 同级）中添加
以下内容：
buildscript {
 repositories {
     mavenCentral()
 }
 dependencies {
     classpath 'com.android.tools.build:gradle:7.0.0'
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.31"
 }
}
说明：
如果您使用 Gradle 8.x，则需要添加以下代码。
buildscript {
 repositories {
     mavenCentral()
     maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" }
 }
 dependencies {
     classpath 'com.android.tools.build:gradle:8.0.2'
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.0"
 }
}
步骤3：开始使用
1. 添加好友。
使用 RestAPI 添加 步骤1 中创建的 AI 聊天机器人为好友。
注意：
为避免您的 AI 资源被恶意消耗，现只支持使用 RestAPI 添加 AI 聊天机器人好友，用户无法主动添加 AI 聊天机器人为好友。
2. 组件登录。
TUIChat 组件登录成功之后才能正常使用 AI 聊天功能。其中，sdkAppID 需要在 即时通信 IM 控制台 创建并获取，userSig 需要按规则计算，详细步骤请参见文档 跑通 Demo > Android。
示例代码如下所示：
// 在用户 UI 点击登录的时候调用
TUILogin.login(context, sdkAppID, userID, userSig, new TUICallback() {
    @Override
    public void onSuccess() {
    }
    
    @Override
    public void onError(final int code, final String desc) {
    }
});
3. 跳转到聊天窗口 Activity。
在控制台上获取 AI 聊天机器人 的 userID，传入参数并跳转到聊天界面。
示例代码如下所示：
经典版
简约版
Intent intent = new Intent(this, TUIC2CChatActivity.class);
// chatID 是机器人的 UserID
intent.putExtra(TUIConstants.TUIChat.CHAT_ID, "chatID");
intent.putExtra(TUIConstants.TUIChat.CHAT_TYPE, V2TIMConversation.V2TIM_C2C);
startActivity(intent);
Intent intent = new Intent(this, TUIC2CChatMinimalistActivity.class);
// chatID 是机器人的 UserID
intent.putExtra(TUIConstants.TUIChat.CHAT_ID, "chatID");
intent.putExtra(TUIConstants.TUIChat.CHAT_TYPE, V2TIMConversation.V2TIM_C2C);
startActivity(intent);
您也可以将 TUIChat 聊天界面，嵌入到自己的 Activity 中。
示例代码如下所示：
经典版
简约版
Fragment fragment;
// chatID 是机器人的 UserID
C2CChatInfo c2cChatInfo = new C2CChatInfo();
c2cChatInfo.setId(chatID);
TUIC2CChatFragment tuic2CChatFragment = new TUIC2CChatFragment();
tuic2CChatFragment.setChatInfo(c2cChatInfo);
fragment = tuic2CChatFragment;
getSupportFragmentManager().beginTransaction()
        .add(R.id.chat_fragment_container, fragment).commitAllowingStateLoss();
Fragment fragment;
// chatID 是机器人的 UserID
C2CChatInfo c2cChatInfo = new C2CChatInfo();
c2cChatInfo.setId(chatID);
TUIC2CChatMinimalistFragment tuic2CChatFragment = new TUIC2CChatMinimalistFragment();
tuic2CChatFragment.setChatInfo(c2cChatInfo);
fragment = tuic2CChatFragment;
getSupportFragmentManager().beginTransaction()
        .add(R.id.chat_fragment_container, fragment).commitAllowingStateLoss();
常见问题
提示 "Manifest merger failed : Attribute application@allowBackup value=(true) from AndroidManifest.xml" 如何处理？
IM SDK 中默认 allowBackup 的值为 false ，表示关闭应用的备份和恢复功能。
您可以在您的 AndroidManifest.xml 文件中删除 allowBackup 属性，表示关闭备份和恢复功能；也可以在 AndroidManifest.xml 文件的 application 节点中添加 tools:replace="android:allowBackup" 表示覆盖 IM SDK 的设置，使用您自己的设置。 
例如：
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    package="com.tencent.qcloud.tuikit.myapplication">
﻿
    <application
        android:allowBackup="true"
        android:name=".MApplication"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.MyApplication"
        tools:replace="android:allowBackup">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
﻿
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
﻿
</manifest>
提示 "NDK at /Users/***/Library/Android/sdk/ndk-bundle did not have a source.properties file" 如何处理？
只需要在 local.properties 文件中加入您的 NDK 路径，例如：
ndk.dir=/Users/***/Library/Android/sdk/ndk/16.1.4479499
提示 "Cannot fit requested classes in a single dex file" 如何处理？
出现此问题可能是您的 API 级别设置比较低，需要在 App 的 build.gradle 文件中开启 MultiDex 支持, 添加 multiDexEnabled true 和对应依赖：
android {
    defaultConfig {
        ...
        minSdkVersion 19
        targetSdkVersion 30
        multiDexEnabled true
    }
    ...
}
dependencies {
    implementation "androidx.multidex:multidex:2.0.1"
}
同时，在您的 Application 文件中添加以下代码：
public class MyApplication extends SomeOtherApplication {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        MultiDex.install(this);
    }
}
提示 "Plugin with id 'kotlin-android' not found." 如何处理？
因为 TUIChat 组件使用了 Kotlin 代码，所以需要添加 Kotlin 构建插件。请参考 集成 TUIChat 源码第 4 步。
Debug 版本的 App 功能正常，Release 版本的 App 功能出现异常 ？
出现此问题很大概率是混淆导致的，请尽量不要混淆 TUIKit 。可以添加如下混淆规则：
# 避免删除代码逻辑
-dontshrink
-dontoptimize
# 避免混淆 TUIKit
-keep class com.tencent.qcloud.** { *; }
﻿
Android

本页目录：

概述

开发环境要求

集成 AI 聊天机器人

步骤1：创建 AI 聊天机器人

步骤2：集成源码

步骤3：开始使用

常见问题
