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

实现自定义消息收发(含UI)

更新时间: 2023/01/06 11:56:54

IM UIKit 的会话消息模块(chatkit-ui)默认实现了文本消息、图片消息等基本消息类型的发送和展示。如果这些消息类型无法满足您的业务需求,您可新增自定义消息类型

基本消息类型

消息类型
显示效果 是否需要额外集成
文本消息 否,集成会话界面即可用
图片消息 否,集成会话界面即可用
语音消息 否,集成会话界面即可用
视频消息 否,集成会话界面即可用
表情 否,集成会话界面即可用
文件消息 否,集成会话界面即可用
地理位置 是,见实现地理位置消息功能

前提条件

集成会话界面

实现流程

步骤1: 自定义消息处理

实现自定义消息收发之前,您需先自行实现消息数据的封装和相关解析规则。IM UIKit 可按照您实现的封装和解析规则对消息进行处理,将消息返回给您的应用。

  1. 创建自定义Attachment,需要继承CustomAttachment,并重写数据解析方法(parse)和数据封装方法(packData)。

    这里假设自定义AttachmentCustomerSampleAttachment进行说明:

    1. 创建CustomerSampleAttachment类。

    2. 将您的自定义消息处理逻辑添加到CustomerSampleAttachment类,主要包括数据解析方法parse和数据封装方法packData。前者将收到的消息进行解析,后者将数据进行封装用于发送。

      public class CustomerSampleAttachment extends CustomAttachment{
      
          //自定义消息解析之后的值,本例代表自定义消息只有一个String类型的值
          private String custmoerText;
      
          //声明构造方法,这里面需要调用父类方法,并传入int值作为消息类型,自定义消息类型推荐从1000开始
          GuessAttachment() {
              super(1002);
          }
      
          //重写数据解析方法,这里面数据以JSONObject格式进行传输,所以您可以制定自己的数据格式。
          //这个示例表示,自定义数据格式为{"customer_message_key":"我是一个自定义消息"}
          @Override
          protected void parseData(JSONObject data) {
              //todo 从接收到的消息内容中解析您的数据
              try {
          this.custmoerText = data.getString("customer_message_key");
          }catch (Exception exception){
          }
          }
      
          //重写数据封装方法,将您需要传递的内容转换为JSONObject格式进行传输,所以您可以制定自己的数据格式。
          //这个示例表示,把属性custmoerText的内容转换为JSONObject,用于消息发送过程中的传递
          @Override
          protected JSONObject packData() {
              //将消息进行封装即可
              JSONObject data = new JSONObject();
          try {
              data.put("customer_message_key", custmoerText);
          }catch (Exception exception){}
      
          return data;
          }
      
          public void setData(String data){
              this.custmoerText = data;
          }
          //设置自定义消息的信息摘要,在会话列表中根据该方法返回进行展示
          @Override
          public String getContent() {
              return "...";
          }
      
      }
      
  2. 在消息数据处理逻辑中,增加自定义消息的映射关系。所有自定义消息都会在CustomAttachParser中进行分发,SDK 将确定您的自定义消息是采用哪个CustomAttachment进行处理。

    ChatKit-UI中,我们已经创建了CustomAttachParser,专门用于自定义消息的处理。您只需要添加您自定义消息的映射关系即可。


    示例代码如下:

    ChatKitClient.addCustomAttach(1002, CustomerSampleAttachment.class);
    

    至此,您已经完成了自定义消息的处理逻辑。如果您获取的消息为该自定义消息类型,就能从IMMessage中获取到CustomerSampleAttachment对象值。

步骤2: 实现自定义消息的 UI 展示

如果需要在会话界面将您的自定义消息按照您自定义的 UI 样式进行展示,那么需要完成如下步骤。

  1. 添加消息展示的ViewHolder,并使其继承ChatBaseMessageViewHolder。也可参考ChatTextMessageViewHolderChatImageMessageViewHolder等中已实现的代码逻辑。

    public class CustomerSampleViewHolder  extends ChatBaseMessageViewHolder {
        private final static String TAG = "ChatStickerViewHolder";
    
        private CustomerSampleViewBinding binding;//创建自己的layout布局
    
        public CustomerSampleViewHolder(@NonNull ChatBaseMessageViewHolderBinding parent, int viewType) {
            super(parent, viewType);
        }
    
        @Override
        public void addContainer() {
            binding = CustomerSampleViewBinding.inflate(LayoutInflater.from(parent.getContext()),
                    getContainer(),true);
        }
    
        @Override
        public void bindData(ChatMessageBean message, ChatMessageBean lastMessage) {
            super.bindData(message, lastMessage);
            currentMessage = message;
            CustomerSampleAttachment attachment = (CustomerSampleAttachment) message.getMessageData().getMessage().getAttachment();
            if (attachment == null) {
                return;
            }
            //todo 设置ViewHolder展示UI的内容
        }
    }
    
  2. CustomerSampleViewHolder添加到 IM UIkit,使 IM UIKit 在加载后能够运行您的自定义消息相关代码逻辑。

    ChatKitClient.addCustomViewHolder(1002, CustomerSampleViewHolder.class);
    
    

步骤3: 实现自定义消息收发

通过 IM UIKit 实现自定义消息收发的流程如下:

  1. 调用createCustomMessage方法创建自定义消息。

        CustomerSampleAttachment customerAttachment = new CustomerSampleAttachment();
        customerAttachment.setData("这是一条自定义消息");
        //创建IMMessage,其中sessionId代表会话ID,sessionType会话类型,content代表消息内容,customerAttachment自定义消息
        IMMessage customMessage = MessageBuilder.createCustomMessage(sessionId, sessionType, content, customerAttachment);
    
  2. 调用ChatRepo.sendMessage方法发送消息。

    IM UIKit 中的实现详见ChatBaseViewModelsendCustomMessage()方法。

    //ChaRepo提供的发送消息接口,任何消息类型都可以使用该接口进行发送
    //customMessage 表示创建的消息体。如果需要在消息发送失败后重发,标记resend参数为true,否则填false。callback表示消息发送回调
    ChatRepo.sendMessage(customMessage, resend, callback);
    
    
  3. 接收方接收消息。

    IM UIKit 中已经实现该接收逻辑,详见ChatBaseViewModelregisterObservers()方法和receiveMessageObserver对象值。

    private final EventObserver<List<IMMessageInfo>> receiveMessageObserver = new EventObserver<List<IMMessageInfo>>() {
            @Override
            public void onEvent(@Nullable List<IMMessageInfo> event) {
                //接收消息处理
            }
        };
    
        //注册消息接收监听,sessionId会话ID,receiveMessageObserver监听器,register true代表注册,false取消注册
        ChatObserverRepo.observeReceiveMessage(sessionId, receiveMessageObserver, register);
    
    

后续步骤

如果需要在会话界面添加发送自定义消息的 UI 控件,可在点击【更多】按钮(见下图)后展示的区域增加相应的按钮。具体实现方式可参考在【更多】区域增加按钮

image
此文档是否对你有帮助?
有帮助
我要吐槽
  • 基本消息类型
  • 前提条件
  • 实现流程
  • 步骤1: 自定义消息处理
  • 步骤2: 实现自定义消息的 UI 展示
  • 步骤3: 实现自定义消息收发
  • 后续步骤