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/04 16:31:01

IM UIKit 提供两种会话列表界面的集成方式,即基于 Activity 和基于 Fragment 。两种集成方式都支持个性化定制界面 UI。

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

功能描述

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

注意:您需要将自定义会话列表 Activity 注册到 IM UIKit 的路由 XKitRouter 中,从而将默认的会话列表 Activity 替换为自定义会话列表 Activity 。

效果展示

IM会话列表效果.png

基于Activity的会话列表集成

IM UIKit 提供默认会话列表 Activity 的类名为ConversationActivity

您可以使用 IM UIKit 提供的路由XKitRouter跳转到默认会话列表界面ConversationActivity

  • XKitRouter原型
XKitRouter.withKey(RouterConstant.PATH_CONVERSATION_PAGE).withContext(context).navigate();
  • XKitRouter参数说明
参数
类型
说明
RouterConstant.PATH_CONVERSATION_PAGE String IM UIKit 默认注册的会话列表界面地址
context Context Activity 上下文

基于Fragment的会话列表集成

IM UIKit 提供会话列表 Fragment 的类名为ConversationFragment。您可以在应用的 Activity 中集成ConversationFragment从而构建您的会话列表界面。

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

步骤1:创建Activity的布局文件

创建您的应用 Activity 的布局文件my_conversation_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/conversation_container"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

</LinearLayout>

步骤2:创建Activity

本步骤以应用的 Acitivity 采用视图绑定(ViewBinding)模式为例进行说明。

示例代码如下:

public class MyConversationActivity extends AppCompatActivity {


    private MyConversationActivityBinding viewBinding;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        viewBinding = MyConversationActivityBinding.inflate(LayoutInflater.from(this));
        //设置Activity界面布局,非ViewBinding采用setContentView(R.layout.conversation_activity);
        setContentView(viewBinding.getRoot());
        FragmentManager fragmentManager = getSupportFragmentManager();
        //创建ConversationFragment
        ConversationFragment fragment = new ConversationFragment();
        //将ConversationFragment加载到Activity中
        fragmentManager
                .beginTransaction()
                .add(R.id.conversation_container, fragment)
                .commit();

    }
}

步骤3:声明Activity

AndroidManfest.xml中声明 Activity。

示例代码如下:

<activity
        android:name=".activity.MyConversationActivity"
        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_CONVERSATION_PAGE, MyConversationActivity.class);

步骤5:实现跳转

使用 IM UIKit 提供的路由器XKitRouter进行跳转。

示例代码如下:

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

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

此文档是否对你有帮助?
有帮助
我要吐槽
  • 功能描述
  • 效果展示
  • 基于Activity的会话列表集成
  • 基于Fragment的会话列表集成
  • 步骤1:创建Activity的布局文件
  • 步骤2:创建Activity
  • 步骤3:声明Activity
  • 步骤4:注册会话列表界面
  • 步骤5:实现跳转