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/11/02 17:05:59

IM UIKit 提供两种会话消息界面(chatkit-ui)的集成方式,即基于 Activity 集成和基于 Fragment 集成。通过这两种方式集成的会话消息界面,都支持个性化定制界面 UI。

会话界面 UI 个性化定制相关说明,请参见自定义会话消息界面 UI

效果展示

会话消息界面效果.png

初始化 chatkit-ui

使用ChatKit-ui之前,需调用ChatKitClient.init方法对该模块进行初始化,以保证该模块功能的正常使用。您可以在 Application 的onCreate方法中初始化ChatKit-ui模块,也可以在您的 Activity 的 onCreate 方法中初始化。

初始化需要在 IM UIKit 界面加载之前进行。

示例代码如下:

public class IMApplication extends MultiDexApplication {

  @Override
  public void onCreate() {
    super.onCreate();
    //初始化ChatKit-UI
    if (NIMUtil.isMainProcess(this)) {
        ChatKitClient.init(context);
    }
  }
}

集成会话消息界面

集成方式
说明
基于 Activity 集成 使用 IM UIKit 提供的默认会话消息界面。界面支持一个标题栏和一个会话消息。在 IM UIKit 内部已经为该界面定义了跳转路径:其他界面需要跳转到会话消息时,将跳转到默认的会话消息 Activity。
基于 Fragment 集成 在您应用的 Activity 中集成 IM UIKit 提供的会话消息 Fragment。

注意您需要将自定义会话消息 Activity 注册到 IMUIKit 的路由 XKitRouter 中,从而将默认的会话消息 Activity 替换为自定义会话消息 Activity 。

基于Activity 集成

IM UIKit 提供默认单聊和群聊会话消息 Activity 的类名为ChatP2PActivityChatTeamActivity

您可以使用 IM UIKit 提供的路由XKitRouter跳转到默认会话消息界面ChatP2PActivityChatTeamActivity

  • XKitRouter原型-单聊
//跳转到单聊界面
XKitRouter.withKey(RouterConstant.PATH_CHAT_P2P_PAGE).withParam(RouterConstant.CHAT_KRY, userInfo).withContext(context).navigate();
  • XKitRouter单聊参数说明
参数
类型
说明
RouterConstant.PATH_CHAT_P2P_PAGE String IM UIKit 默认注册的会话消息界面地址
userInfo UserInfo IM UIKit 用户信息的实体类
context Context Activity 上下文
  • XKitRouter原型-群聊
//跳转到群聊界面
XKitRouter.withKey(RouterConstant.PATH_CHAT_TEAM_PAGE).withParam(CHAT_KRY, teamInfo).withContext(context).navigate();
  • XKitRouter参数说明
参数
类型
说明
RouterConstant.PATH_CHAT_TEAM_PAGE String IM UIKit 默认注册的会话消息界面地址
teamInfo TeamInfo IM UIKit 群组信息实体类
context Context Activity 上下文

基于 Fragment 集成

集成单聊界面

IM UIKit 提供的单聊 Fragment 的类名为ChatP2PFragment。您可以在应用的 Activity 中集成ChatP2PFragment从而构建您的单聊界面。

本节假设您的应用的 Acitiviy 为MyChatP2PActivity,进行相应说明。

  1. 创建您的应用 Activity 的布局文件my_chat_p2p_activity.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:ignore="MissingDefaultResource">
    
    //用来放置Fragment
        <FrameLayout
            android:id="@+id/chat_container"
            android:layout_width="match_parent"
            android:layout_height="match_parent" />
    
    </LinearLayout>
    
  2. 创建 Activity。本步骤以应用的 Acitivity 采用视图绑定(ViewBinding)模式为例进行说明。

    示例代码如下:

    public class MyChatP2PActivity extends AppCompatActivity {
    
    
        private MyChatP2PActivityBinding viewBinding;
    
        @Override
        protected void onCreate(@Nullable Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            viewBinding = MyChatP2PActivityBinding.inflate(LayoutInflater.from(this));
            //设置Activity界面布局,非ViewBinding采用setContentView(R.layout.my_chat_p2p_activity);
            setContentView(viewBinding.getRoot());
            UserInfo userInfo = (UserInfo) getIntent().getSerializableExtra(RouterConstant.CHAT_KRY);
            if (userInfo == null) {
                finish();
            }
            FragmentManager fragmentManager = getSupportFragmentManager();
            //创建ChatP2PFragment
            P2PChatFragmentBuilder fragmentBuilder = new P2PChatFragmentBuilder();
            ChatP2PFragment chatFragment = fragmentBuilder.build();
            Bundle bundle = new Bundle();
            bundle.putSerializable(RouterConstant.CHAT_KRY, userInfo);
            chatFragment.setArguments(bundle);
            //将ChatP2PFragment加载到Activity中
            fragmentManager
                    .beginTransaction()
                    .add(R.id.chat_container, chatFragment)
                    .commitAllowingStateLoss();
    
        }
    }
    
    
  3. AndroidManfest.xml中声明 Activity。

    示例代码如下:

    <activity
            android:name=".activity.MyChatP2PActivity"
            android:launchMode="singleTop"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="stateHidden|adjustResize">
    </activity>
    
  4. 注册会话消息界面。

    调用XKitRouter中的会话消息注册方法registerRouter,同时进行相应配置(参考本步骤的示例代码),将 IM UIKit 的默认会话消息界面替换为您的 Activity 界面。

    • 方法原型
    XKitRouter.registerRouter(path,activity);
    
    • 参数说明
    参数 类型 说明
    path String Activity 的跳转地址
    activity Class 跳转的目标 Activity
    • 示例代码
    XKitRouter.registerRouter(RouterConstant.PATH_CHAT_P2P_PAGE, MyChatP2PActivity.class);
    
  5. 使用 IM UIKit 提供的路由器XKitRouter进行跳转。

    示例代码如下:

    XKitRouter.withKey(RouterConstant.PATH_CHAT_P2P_PAGE).withContext(context).navigate();
    

集成群聊界面

IM UIKit 提供的群聊 Fragment 的类名为ChatTeamFragment。您可以在应用的 Activity 中集成ChatTeamFragment从而构建您的群聊界面。

本节假设您的应用的 Acitiviy 为ChatTeamActivity,进行相应说明。

  1. 创建您的应用 Activity 的布局文件my_chat_team_activity.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:ignore="MissingDefaultResource">
    
    //用来放置Fragment
        <FrameLayout
            android:id="@+id/chat_container"
            android:layout_width="match_parent"
            android:layout_height="match_parent" />
    
    </LinearLayout>
    
  2. 创建 Activity。本步骤以应用的 Acitivity 采用视图绑定(ViewBinding)模式为例进行说明。

    示例代码如下:

    public class MyChatTeamActivity extends Activity {
    
    
        private MyChatTeamActivityBinding viewBinding;
    
        @Override
        protected void onCreate(@Nullable Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            viewBinding = MyChatTeamActivityBinding.inflate(LayoutInflater.from(this));
            //设置Activity界面布局,非ViewBinding采用setContentView(R.layout.my_chat_p2p_activity);
            setContentView(viewBinding.getRoot());
            Team teamInfo = (Team) getIntent().getSerializableExtra(RouterConstant.CHAT_KRY);
            if (teamInfo == null) {
                finish();
                return();
            }
            FragmentManager fragmentManager = getSupportFragmentManager();
            //创建ChatP2PFragment
            ChatTeamFragment chatFragment = new ChatTeamFragment();
            Bundle bundle = new Bundle();
            bundle.putSerializable(RouterConstant.CHAT_KRY, teamInfo);
            chatFragment.setArguments(bundle);
            //将ChatP2PFragment加载到Activity中
            fragmentManager
                    .beginTransaction()
                    .add(R.id.chat_container, chatFragment)
                    .commitAllowingStateLoss();
    
        }
    }
    
    
  3. AndroidManfest.xml中声明 Activity。

    示例代码如下:

    <activity
            android:name=".activity.MyChatTeamActivity"
            android:launchMode="singleTop"
            android:screenOrientation="portrait"
            android:windowSoftInputMode="stateHidden|adjustResize">
    </activity>
    
  4. 注册会话消息界面。

    调用XKitRouter中的会话消息注册方法registerRouter,同时进行相应配置(参考本步骤的示例代码),将 IM UIKit 的默认会话消息界面替换为您的 Activity 界面。

    • 方法原型
    XKitRouter.registerRouter(path,activity);
    
    • 参数说明
    参数 类型 说明
    path String Activity 的跳转地址
    activity Class 跳转的目标 Activity
    • 示例代码
    XKitRouter.registerRouter(RouterConstant.PATH_CHAT_TEAM_PAGE, MyChatTeamActivity.class);
    
  5. 使用 IM UIKit 提供的路由器XKitRouter进行跳转。

    示例代码如下:

    XKitRouter.withKey(RouterConstant.PATH_CHAT_TEAM_PAGE).withContext(context).navigate();
    

    路由器XKitRouter的具体使用说明,请参见界面跳转

此文档是否对你有帮助?
有帮助
我要吐槽
  • 效果展示
  • 初始化 chatkit-ui
  • 集成会话消息界面
  • 基于Activity 集成
  • 基于 Fragment 集成
  • 集成单聊界面
  • 集成群聊界面