IM 即时通讯
Android
新手接入指南
产品介绍
简介
主要功能
产品优势
海外数据中心
接口及业务限制
功能介绍
帐号集成与登录
群组功能
聊天室功能
聊天室标签功能
圈组功能
多端登录与互踢策略
质量数据监控台
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
IM UIKit API 概览
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
不含 UI 集成
使用说明
集成与初始化
登录管理
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
多媒体资源存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
离线推送与消息提醒
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道未读数管理
实时互动频道
频道分组
频道分组黑白名单
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限
成员权限查询与判定
身份组相关查询
圈组订阅机制
消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
会话消息回复(Thread)
圈组快捷评论
消息正在输入
获取频道最后一条消息
查询历史消息
圈组消息缓存
圈组消息搜索
系统通知
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
反垃圾
聊天扩展
其他
最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android API 参考
Android 端状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
常见问题
FAQ
错题集
Android 端推送问题排查
服务协议

快速集成 IM UIKit

更新时间: 2022/11/22 11:37:54

云信 IM UIKit 是基于 NIM SDK(网易云信 IM SDK)开发的一款即时通讯 UI 组件库,包括聊天、会话、圈组(类 Discord 场景)、搜索、群管理等组件。本文介绍如何快速跑通 IM UIKit 的集成流程。

主要模块.png

前提条件

在开始集成 IM UIKit 前,请确保您已:

  • 云信控制台完成以下操作。


    创建应用并获取 App Key 和 App Secret 1. 在左侧导航栏中找到“应用”,并单击“创建”。
    创建应用
    2. 填写应用的基本信息后,单击“创建”。
    创建应用
    3. 创建应用后,可以在左侧导航栏中查看该应用,并单击 “App Key 管理”,并获取 App Key 和 App Secret。
    查看应用的AppKey
    注册云信 IM 账号,获取 accid 和 token

    注册云信 IM 账号,获取 accid 和 token。accid 和 token 将用于登录云信服务端。

    1. 在左侧导航栏中单击指定应用名称,进入该应用的详情页面。
    2. 在“功能管理”中单击“账号管理”。
    账号管理
    3. 在测试页面,单击“新建账号”,并填写账号(即accid)、昵称(即 name)、密码(即 Token)后,单击“确定”。
    确定
  • 准备如下开发环境/工具:

    • Android Studio Bumblebee
    • Java 11
    • Gradle 7.4.1
    • Android Gradle Plugin 7.1.3

实现流程

uml diagram

步骤1:按需导入组件

根据业务需要,在您的项目的 build.gradle 中,以添加依赖的形式添加相应的 IM UIKit 组件和第三方库(Glide、Retrofit 和 OkHttp)。

例如,需要通讯录功能和会话列表功能,可添加 contactkit-uiconversationkit-ui

dependencies { 
    // 通讯录功能
    implementation("com.netease.yunxin.kit.contact:contactkit-ui:${LATEST_VERSION}")
    // 圈组功能组件
    implementation("com.netease.yunxin.kit.qchat:qchatkit-ui:${LATEST_VERSION}")
    // 会话列表功能组件
    implementation("com.netease.yunxin.kit.conversation:conversationkit-ui:${LATEST_VERSION}")
    // 群组功能组件
    implementation("com.netease.yunxin.kit.team:teamkit-ui:${LATEST_VERSION}")
    // 聊天功能组件
    implementation("com.netease.yunxin.kit.chat:chatkit-ui:${LATEST_VERSION}")
    // 搜索功能组件
    implementation("com.netease.yunxin.kit.search:searchkit-ui:${LATEST_VERSION}")
    //图片库
    implementation("com.github.bumptech.glide:glide:4.13.1")  
    //网络库
    implementation("com.squareup.retrofit2:retrofit:2.9.0")
    implementation("com.squareup.retrofit2:converter-gson:2.9.0")
    implementation("com.squareup.retrofit2:converter-scalars:2.9.0")
    implementation("com.squareup.okhttp3:okhttp:4.9.3")
}
  • 各组件相互独立,添加或删除均不影响项目编译。
  • 更多组件导入说明,请参见组件导入

步骤2:初始化

  1. AndroidManefest.xml中配置 APP Key。

    示例代码如下:

    //在application节点里面增加<meta-data>配置APPKey
        <application ...>
            <meta-data
                android:name="com.netease.nim.appKey"
                android:value="your APPKey" />
    </application>
    
    
  2. 在 IM UIKit 项目的 IMApplication 的 onCreate 中添加如下代码。

    public class IMApplication extends MultiDexApplication {
        @Override
        public void onCreate() {
            super.onCreate();
            // 在Application的onCreate中添加
            SDKOptions options = new SDKOptions();
            //填入APPKEY
            options.appKey = "APP KEY";
            //如果有account和token信息可以填入登录信息直接进行登录
            LoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("account", "token").build();
            IMKitClient.init(this,loginInfo,options);
    
            if (IMKitUtils.isMainProcess(this)) {
                //会话消息模块需要初始化
                ChatKitClient.init(this);
            }
        }
    }
    
    

    更多初始化说明,请参见初始化

步骤3:登录

如果登录信息(LoginInfo)在初始化的时候已传入,则不需要再进行本节内容介绍的登录步骤。


如果不能在 Applicatiton 中获取登录信息LoginInfo,需调用IMKitClient类中的如下方法:

方法名 参数 说明
loginIMWithQChat LoginInfo 同时登录 IM 和圈组。如果后续需要同时实现常规 IM 功能和圈组功能(类 Discord 场景的功能),需选择本登录方式如需调用该方法登录,请确保您已开通圈组功能,否则将报错403。如未开通,请在云信官网首页通过在线咨询、微信或电话联系商务经理开通该功能。
loginIM LoginInfo 仅登录 IM。如果后续不需要实现类 Discord 场景的功能,而仅需要实现常规 IM 的功能,如单聊、群聊和通讯录等,请选择本登录方式

调用登录的方法时,将如下示例代码中的 accidtoken 分别替换为您的云信账号 ID (即 accid)和 Token。

同时登录 IM 和 圈组(loginIMWithQChat)
LoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("accid","token").build();
IMKitClient.loginIMWithQChat(loginInfo,new LoginCallback<QChatLoginResult>() {
    @Override
    public void onError(int errorCode, @NonNull String errorMsg) {
        //登录失败
    }

    @Override
    public void onSuccess(@Nullable QChatLoginResult data) {
        //登录成功
    }
});

仅登录 IM(loginIM)
LoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("accid","token").build();
IMKitClient.loginIM(loginInfo,new LoginCallback<LoginInfo>() {
    @Override
    public void onError(int errorCode, @NonNull String errorMsg) {
        //登录失败
    }

    @Override
    public void onSuccess(@Nullable LoginInfo data) {
        //登录成功
    }
});

步骤4:界面搭建

以搭建会话列表界面为例,基本流程如下:

  1. 在您应用中需要添加会话列表界面的 Activity 下创建conversationFragment

    示例代码如下:

    ConversationFragment conversationFragment = new ConversationFragment();
    
  2. conversationFragment添加到这个 Activity 中。

        FragmentManager fragmentManager = getSupportFragmentManager();
        //R.id.container 你添加界面的GroupLayout
        fragmentManager
            .beginTransaction().add(R.id.container, conversationFragment)
            .commit();
    

    上述示例代码中的getSupportFragmentManager方法属于 Android Activity 的默认方法,如果您使用 Android X 中的AddCompatActivity则可以直接调用该方法。如果您使用的是android.app.acitivity,则需要调用getFragmentManager方法。


    最终集成效果参考下图。

界面集成详情

IM UIKit 中提供的常用业务场景界面及相关详细集成说明如下:

界面 所属组件 描述
ConversationFragment conversationkit-ui 会话列表界面(创建或者跳转到该界面需要传入参数,详见集成会话列表界面
ContactFragment contactkit-ui 通讯录界面 (创建或者跳转到该界面需要传入参数,详见集成通讯录界面
QChatServerFragment qchatkit-ui 圈组列表界面
ChatP2PFragment/ChatP2PActivity chatkit-ui 单聊会话界面(创建或者跳转到该界面需要传入参数,详见集成会话界面
ChatTeamFragment/ChatTeamActivity chatkit-ui 群聊会话界面(创建或者跳转到该界面需要传入参数,详见集成会话界面

后续步骤

为保障通信安全,如果您在调试环境中的使用的是云信控制台生成的测试用 IM 账号 和 token,请确保在后续的正式生产环境中,将其替换为通过 IM 服务端 API 生成的正式 IM 账号(accid)和 token

此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 实现流程
  • 步骤1:按需导入组件
  • 步骤2:初始化
  • 步骤3:登录
  • 步骤4:界面搭建
  • 界面集成详情
  • 后续步骤