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 端推送问题排查
服务协议

组件导入

更新时间: 2022/10/28 11:41:22

IM UIKit (Android) 采用 Gradle 进行构建,您可以采用添加远端仓库依赖或者本地代码依赖的方式,将所需组件快速导入到您的项目中。

  • 添加远端仓库依赖:适用于采用 IM UIKit 默认界面的集成。
  • 添加本地代码依赖:适用于通过 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

实现流程

方式1:添加远端仓库依赖

本节以会话列表组件为例,介绍如何采用添加远端依赖的方式,将该组件导入到您的项目中,进行项目构建。

  1. 在 app 目录下的build.gradle中添加远端依赖。

    dependencies {
        //通讯录组件
        api 'com.netease.yunxin.kit.contact:contactkit-ui:9.2.9'
        //圈组组件
        api 'com.netease.yunxin.kit.qchat:qchatkit-ui:9.2.9'
        //会话列表组件
        api 'com.netease.yunxin.kit.conversation:conversationkit-ui:9.2.9'
        //群组设置组件
        api 'com.netease.yunxin.kit.team:teamkit-ui:9.2.9'
        //会话消息组件(聊天界面,包括单聊和群聊)
        api 'com.netease.yunxin.kit.chat:chatkit-ui:9.2.9'
        // 联系人搜索组件
        api 'com.netease.yunxin.kit.search:searchkit-ui:9.2.9'
    }
    
    

    如果是 kotlin 脚本配置,在应用根目录下,打开build.gradle.kts,声明云信 IM UIKit 代码仓库。

    dependencies {
        api("com.netease.yunxin.kit.contact:contactkit-ui:9.2.9")
        api("com.netease.yunxin.kit.qchat:qchatkit-ui:9.2.9")
        api("com.netease.yunxin.kit.conversation:conversationkit-ui:9.2.9")
        api("com.netease.yunxin.kit.team:teamkit-ui:9.2.9")
        api("com.netease.yunxin.kit.chat:chatkit-ui:9.2.9")
        api("com.netease.yunxin.kit.search:searchkit-ui:9.2.9")
    }
    
    

    上述示例代码中的9.2.9表示版本号,仅用于示例。

  2. 在项目根目录下,打开gradle.propertes, 修改资源依赖配置。

    android.nonTransitiveRClass=false
    

    如果导入之后,出现资源找不到的问题,请修改此处配置。
    IM UIKit 模块化设计,所以存在资源依赖,以减少包体积。

方式2:添加本地代码依赖

本节介绍如何通过添加本地代码依赖的方式,将所需的 IM UIKit 组件导入到您的项目。

  1. 前往云信开源代码仓库,下载 nim-uikit-android 源码组件到本地。

  2. 在 Android Studio 中打开工程后,依次点击 File > New > Import Module,选择您需要的组件导入,或者将组件直接复制到您的项目中。

    开源工程中包括的源码组件如下:

    组件 说明
    chatkit-ui 会话消息组件(聊天界面,包括单聊和群聊)
    conversationkit-ui 会话列表组件
    contactkit-ui 通讯录组件
    qchatkit-ui 圈组组件
    searchkit-ui 联系人搜索组件
    teamkit-ui 群组设置组件
  3. 在项目根目录下,打开gradle.propertes, 修改属性资源依赖配置。

    android.nonTransitiveRClass=false
    

    如果导入之后,出现资源找不到的问题,请修改此处配置。
    IM UIKit 模块化设计,所以存在公共资源依赖,以减少包体积。

  4. 在 Android Studio 项目根目录下,打开settings.gradle,添加依赖组件。

    如果第 1 步操作采用导入方式,会自动添加依赖组件,此时只需要检查即可。

    
    include ':app'
    //添加您需要的组件即可
    include ':contactkit-ui'
    include ':chatkit-ui'
    
    

    如果是 kotlin 脚本配置,在项目根目录下,打开settings.gradle.kts,进行添加。

    include(":app")
    include(":searchkit-ui")
    include(":conversationkit-ui")
    include(":teamkit-ui")
    include(":contactkit-ui")
    include(":qchatkit-ui")
    include(":chatkit-ui")
    
    
  5. 在 Android Studio 项目应用目录下,打开app/build.gradle,添加依赖组件。

    //添加您需要的组件即可
    api(project(":contactkit-ui"))
    api(project(":conversationkit-ui"))
    api(project(":qchatkit-ui"))
    api(project(":teamkit-ui"))
    api(project(":chatkit-ui"))
    api(project(":searchkit-ui"))
    
    

后续步骤

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

此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 实现流程
  • 方式1:添加远端仓库依赖
  • 方式2:添加本地代码依赖
  • 后续步骤