MessageService class
消息服务
- Annotations
Constructors
- MessageService()
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
onClearHistoryNotifications
→ Stream<
List< NIMClearHistoryNotification> > -
消息被清空通知
no setter
-
onMessageDeletedNotifications
→ Stream<
List< NIMMessageDeletedNotification> > -
消息被删除通知
no setter
-
onMessagePinNotification
→ Stream<
NIMMessagePinNotification> -
消息pin状态回调通知
no setter
-
onMessageQuickCommentNotification
→ Stream<
NIMMessageQuickCommentNotification> -
消息评论状态回调
no setter
-
onMessageRevokeNotifications
→ Stream<
List< NIMMessageRevokeNotification> > -
消息撤回回调
no setter
-
onReceiveMessages
→ Stream<
List< NIMMessage> > -
消息接收
no setter
-
onReceiveMessagesModified
→ Stream<
List< NIMMessage> > -
消息更新通知
no setter
-
onReceiveP2PMessageReadReceipts
→ Stream<
List< NIMP2PMessageReadReceipt> > -
点对点已读回执
no setter
-
onReceiveTeamMessageReadReceipts
→ Stream<
List< NIMTeamMessageReadReceipt> > -
群消息已读回执
no setter
-
onSendMessage
→ Stream<
NIMMessage> -
本端发送消息状态回调
no setter
-
onSendMessageProgress
→ Stream<
NIMSendMessageProgress> -
本端发送消息进度回调
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addCollection(
{required NIMAddCollectionParams params}) → Future< NIMResult< NIMCollection> > - 添加收藏
-
addQuickComment(
{required NIMMessage message, required int index, String? serverExtension, NIMMessageQuickCommentPushConfig? pushConfig}) → Future< NIMResult< void> > - 添加快捷评论
-
cancelMessageAttachmentUpload(
{required NIMMessage message}) → Future< NIMResult< void> > - 取消文件类附件上传，只有文件类消息可以调用该接口
-
clearHistoryMessage(
{required NIMClearHistoryMessageOption option}) → Future< NIMResult< void> > - 清空历史消息 同步删除本地消息，云端消息 会话不会被删除
-
deleteMessage(
{required NIMMessage message, String? serverExtension, bool? onlyDeleteLocal}) → Future< NIMResult< void> > - 删除消息 如果消息未发送成功,则只删除本地消息
-
deleteMessages(
{required List< NIMMessage> messages, String? serverExtension, bool? onlyDeleteLocal}) → Future<NIMResult< void> > - 批量删除消息 如果单条消息未发送成功， 则只删除本地消息 每次50条, 不能跨会话删除,所有消息都属于同一个会话 删除本地消息不会多端同步，删除云端会多端同步
-
getCollectionListByOption(
{required NIMCollectionOption option}) → Future< NIMResult< List< >NIMCollection> > - 获取收藏列表
-
getLocalThreadMessageList(
{required NIMMessageRefer messageRefer}) → Future< NIMResult< NIMThreadMessageListResult> > - 本地查询thread聊天消息列表 如果消息已经删除， 回复数， 回复列表不包括已删除消息
-
getMessageList(
{required NIMMessageListOption option}) → Future< NIMResult< List< >NIMMessage> > - 查询历史消息，分页接口，每次默认50条，可以根据参数组合查询各种类型
-
getMessageListByIds(
{required List< String> messageClientIds}) → Future<NIMResult< List< >NIMMessage> > - 根据ID列表查询消息，只查询本地数据库
-
getMessageListByRefers(
{required List< NIMMessageRefer> messageRefers}) → Future<NIMResult< List< >NIMMessage> > - 根据MessageRefer列表查询消息
-
getP2PMessageReceipt(
{required String conversationId}) → Future< NIMResult< NIMP2PMessageReadReceipt> > - 查询点对点消息已读回执
-
getPinnedMessageList(
{required String conversationId}) → Future< NIMResult< List< >NIMMessagePin> > - 获取 pin 消息列表
-
getQuickCommentList(
{required List< NIMMessage> messages}) → Future<NIMResult< Map< >String, List< >NIMMessageQuickComment> ?> - 获取快捷评论
-
getTeamMessageReceiptDetail(
{required NIMMessage message, Set< String> ? memberAccountIds}) → Future<NIMResult< NIMTeamMessageReadReceiptDetail> > - 获取群消息已读回执状态详情
-
getTeamMessageReceipts(
{required List< NIMMessage> messages}) → Future<NIMResult< List< >NIMTeamMessageReadReceipt> > - 获取群消息已读回执状态
-
getThreadMessageList(
{required NIMThreadMessageListOption threadMessageListOption}) → Future< NIMResult< NIMThreadMessageListResult> > - 查询thread聊天云端消息列表 建议查询getLocalThreadMessageList， 本地消息已经完全同步，减少网络请求， 以及避免触发请求频控
-
insertMessageToLocal(
{required NIMMessage message, required String conversationId, String? senderId, int? createTime}) → Future< NIMResult< NIMMessage> > - 插入一条本地消息， 该消息不会 该消息不会多端同步，只是本端显示 插入成功后， SDK会抛出回调
-
isPeerRead(
{required NIMMessage message}) → Future< NIMResult< bool> > - 查询点对点消息是否对方已读 内部判断逻辑为： 消息时间小于对方已读回执时间都为true
-
messageDeserialization(
String msg) → Future< NIMResult< NIMMessage> > -
字符串反序列化为消息对象
msgmessageSerialization方法序列化后的字符串 反序列化后的消息对象 -
messageSerialization(
NIMMessage message) → Future< NIMResult< String> > -
消息序列化为字符串
message消对象 返回序列化后的字符串 -
modifyMessage(
NIMMessage message, NIMModifyMessageParams params) → Future< NIMResult< NIMModifyMessageResult> > -
更新消息
message需要更新的消息params更新参数 -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pinMessage(
{required NIMMessage message, String? serverExtension}) → Future< NIMResult< void> > - Pin一条消息
-
removeCollections(
{required List< NIMCollection> collections}) → Future<NIMResult< int> > - 移除收藏
-
removeQuickComment(
{required NIMMessageRefer messageRefer, required int index, String? serverExtension}) → Future< NIMResult< void> > - 移除快捷评论
-
replyMessage(
{required NIMMessage message, required NIMMessage replyMessage, NIMSendMessageParams? params}) → Future< NIMResult< NIMSendMessageResult> > - 回复消息
-
revokeMessage(
{required NIMMessage message, NIMMessageRevokeParams? revokeParams}) → Future< NIMResult< void> > - 撤回消息 只能撤回已经发送成功的消息
-
searchCloudMessages(
{required NIMMessageSearchParams params}) → Future< NIMResult< List< >NIMMessage> > - 搜索云端消息
-
sendMessage(
{required NIMMessage message, required String conversationId, NIMSendMessageParams? params}) → Future< NIMResult< NIMSendMessageResult> > - 发送消息 如果需要更新发送状态，请监听 onSendMessage。 如果需要更新发送进度，请监听 onSendMessageProgress。
-
sendP2PMessageReceipt(
{required NIMMessage message}) → Future< NIMResult< void> > - 发送消息已读回执
-
sendTeamMessageReceipts(
{required List< NIMMessage> messages}) → Future<NIMResult< void> > - 发送群消息已读回执 所有消息必须属于同一个会话
-
toString(
) → String -
A string representation of this object.
inherited
-
unpinMessage(
{required NIMMessageRefer messageRefer, String? serverExtension}) → Future< NIMResult< void> > - 取消一条Pin消息
-
updateCollectionExtension(
{required NIMCollection collection, String? serverExtension}) → Future< NIMResult< NIMCollection> > - 更新收藏扩展字段
-
updateMessageLocalExtension(
{required NIMMessage message, required String localExtension}) → Future< NIMResult< NIMMessage> > - 更新消息本地扩展字段
-
updatePinMessage(
{required NIMMessage message, String? serverExtension}) → Future< NIMResult< void> > - 更新一条Pin消息
-
voiceToText(
{required NIMVoiceToTextParams params}) → Future< NIMResult< String> > - 语音转文字
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited