输入状态
应用程序可以向超级群中发送当前用户输入状态。超级群内收到通知的用户可以在 UI 展示 “ xxx 正在输入”。
提示
为保证最佳体验,建议在仅在人数小于 10,000 的超级群中使用该功能。
发送输入状态
应用程序可以在当前用户输入文本时调用 sendUltraGroupTypingStatus
,发送当前用户输入状态。
方法
Future<int> sendUltraGroupTypingStatus(String targetId, String? channelId, RCIMIWUltraGroupTypingStatus typingStatus, {IRCIMIWSendUltraGroupTypingStatusCallback? callback});
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
targetId | String | 会话 ID |
channelId | String | 频道 ID,仅支持超级群使用。 |
typingStatus | RCIMIWUltraGroupTypingStatus | 输入状态 |
callback | IRCIMIWSendUltraGroupTypingStatusCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Future<int> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码 |
代码示例
IRCIMIWSendUltraGroupTypingStatusCallback? callback = IRCIMIWSendUltraGroupTypingStatusCallback(onUltraGroupTypingStatusSent: (int? code) {
//...
});
int? ret = await engine?.sendUltraGroupTypingStatus(targetId, channelId, typingStatus, callback:callback);
回调方法
- onUltraGroupTypingStatusSent
Function(int? code, String? targetId, String? channelId, RCIMIWUltraGroupTypingStatus? typingStatus)? onUltraGroupTypingStatusSent;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | int | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
targetId | String | 会话 ID |
channelId | String | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
typingStatus | RCIMIWUltraGroupTypingStatus | 输入状态枚举 |
代码示例
engine?.onUltraGroupTypingStatusSent = (int? code, String? targetId, String? channelId, RCIMIWUltraGroupTypingStatus? typingStatus) {
//...
};
监听用户输入状态变化
当超级群用户的输入状态发生变化时,会回调下面方法。为了减少服务端和客户端的压力,服务端会将一段时间内(例如 5 秒)用户输入事件汇总之后统一批量下发,所以回调以数组形式提供。应用程序收到通知时可以在 UI 展示 “ xxx 正在输入”。
方法
Function(List<RCIMIWUltraGroupTypingStatusInfo>? info)? onUltraGroupTypingStatusChanged;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
info | List<RCIMIWUltraGroupTypingStatusInfo> | 正在输入的RCUltraGroupTypingStatusInfo列表(nil 表示当前没有用户正在输入) |
代码示例
engine?.onUltraGroupTypingStatusChanged = (List<RCIMIWUltraGroupTypingStatusInfo>? info) {
//...
};