Flutter

消息正在输入

更新时间: 2024/11/21 17:18:40

网易云信即时通讯 NIM SDK 中的QChatMessageService接口,提供sendTypingEvent方法发送“正在输入事件”。接收方只有在监听该事件且订阅消息所在频道后,才能在消息输入方发送该事件后,接收到该事件。

前提条件

发送方和接收方都在频道内,即频道对两者都可见, 且发送方拥有发送频道消息权限(即QChatRoleResource中的 sendMsg)。

  • 要实现频道对发送方和接收方都可见,需确保两者都在私密频道的白名单内,或者都没有被加入公开频道的黑名单,具体参见频道黑白名单
  • 用户的操作权限通过身份组进行管控,具体参见身份组相关

实现流程

流程概览

sequenceDiagram



note over NIM SDK: 初始化 SDK 并登录 IM
note over NIM SDK: 注册监听并登录圈组
发送方 ->> NIM SDK: 登录圈组
接收方 ->> NIM SDK: 监听正在输入事件<br>(onReceiveTypingEvent)
接收方 ->> NIM SDK: 登录圈组
note over NIM SDK: 双方都成为同一服务器的成员
note over NIM SDK: 双方都能访问同一频道
note over NIM SDK: 接收方订阅频道
接收方 ->> NIM SDK: 订阅频道<br>(subscribeChannel)
note left of 接收方: 订阅类型设置为channelMsgTyping
note over NIM SDK: 发送方拥有发送消息的权限
note over NIM SDK: 消息收发
发送方 ->> NIM SDK: 发送正在输入事件<br>(sendTypingEvent)
note left of 发送方: 发送方输入时调用
NIM SDK ->> 接收方: 正在输入事件(QChatTypingEvent)

流程说明

本节仅对上图中标为部分的流程进行说明,其他流程请参考相关文档。例如:


  1. 接收方调用onReceiveTypingEvent方法监听正在输入事件(QChatTypingEvent)。

  2. 接收方调用subscribeChannel方法,调用时将入参QChatSubscribeType设为channelMsgTyping,实现对正在输入事件的订阅。

    如果断线重连,SDK 会自动再次订阅正在输入事件。但如果用户调用 logout 方法切断与圈组服务端的连接或销毁 SDK 实例后重建实例,那么用户需要再度调subscribeChannel方法重新订阅该事件。

  3. 发送方调用sendTypingEvent方法发送正在输入事件。

    发送该事件后,SDK 会触发用户A 在onReceiveTypingEvent方法中设置的回调,将QChatTypingEvent投递至用户A。

    该方法有调用频率上限,目前默认 3000 ms 一次。

示例代码

//************************接收方设置正在输入事件监听回调************************/
NimCore.instance.qChatObserver.onReceiveTypingEvent.listen((event) { 
      //todo 
    })


//************************接收方订阅某正在输入事件************************/

var param = QChatSubscribeChannelParam(type: QChatSubscribeType.channelMsgTyping,
        operateType: QChatSubscribeOperateType.sub,channelIdInfos: [channel])
    NimCore.instance.qChatChannelService.subscribeChannel(param).then((value){

    });

//************************发送方发送正在输入事件************************/
var param = QChatSendTypingEventParam(serverId: serverId,channelId: channelId);
    NimCore.instance.qChatMessageService.sendTypingEvent(param).then((value){
      //todo 
    });

API 参考

API
说明
onReceiveTypingEvent 监听正在输入事件
subscribeChannel 订阅频道
sendTypingEvent 发送正在输入事件
此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 实现流程
  • 流程概览
  • 流程说明
  • 示例代码
  • API 参考