Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IReceivedConversationByTag

Hierarchy

Index

Properties

Properties

conversationType

conversationType: ConversationType

会话类型

targetId

targetId: string

会话 Id

description
  • 当 conversationType 为 ConversationType.GROUP 或 ConversationType.ULTRA_GROUP 时，该值为群组 Id
  • 当 conversationType 为 ConversationType.PRIVATE 时，该值为对方用户 Id

Optional channelId

channelId?: string

会话的业务标识

description
  • 当会话类型为超级群时，该值为频道 ID
  • 当会话类型为单、群聊时，该值为组织 ID，用于区分多组织场景
  • 其他会话类型该值为空

latestMessage

latestMessage: null | IReceivedMessage

会话中的最后一条消息

Optional unreadMessageCount

unreadMessageCount?: number

当前会话的未读消息数

Optional hasMentioned

hasMentioned?: boolean

未读消息中是否包含 @ 自己、@ 所有人的消息

Optional mentionedInfo

mentionedInfo?: MentionedInfo

消息中的 @ 数据

description
  • 仅支持 Web 端；该数据基于本地接收到的消息计算得出，服务器不记录
  • 仅支持群聊会话，自 5.20.0 版本开始，支持超级群会话类型

Optional lastUnreadTime

lastUnreadTime?: number
deprecated

废弃，该字段为内部记录，用于接收消息时避免本地计数重复

  • 本地收消息时，避免重新收消息导致技术重复
  • 本地撤回消息时，计算是否需要本地计数 -1

Optional notificationStatus

notificationStatus?: NotificationStatus

会话免打扰状态

description
  1. 已开启免打扰
  2. 未开启免打扰

Optional notificationLevel

notificationLevel?: NotificationLevel

会话免打扰状态

Optional isTop

isTop?: boolean

会话是否已置顶

Optional versionTime

versionTime?: number

会话项变更时间戳

deprecated

字段已废弃即将删除，请勿使用

Optional matchCount

matchCount?: number

按消息搜索会话时，匹配到的消息数量（仅 Electron 平台相关搜索接口返回值有效）

Optional unreadMentionedCount

unreadMentionedCount?: number

会话的 @ 消息未读数

since

5.7.9

description
  • 该属性仅 Web 端有效；Electron 平台可通过 getUnreadMentionedMessages 接口获取未读 @ 消息列表计算
  • 该属性仅超级群会话有效，数据基于服务器记录，并依据接收到的消息进行本地维护
  • 自 5.20.0 版本开始，新增支持单群聊会话，数据基于本地接收到的消息计算得出，服务器不记录

Optional unreadMentionedMeCount

unreadMentionedMeCount?: number

@ 我的未读消息数

since

5.7.9

description
  • 该属性仅 Web 端有效；Electron 平台可通过 getUnreadMentionedMessages 接口获取未读 @ 消息列表计算
  • 该属性仅超级群会话有效，数据基于服务器记录，并依据接收到的消息进行本地维护
  • 自 5.20.0 版本开始，新增支持单群聊会话，数据基于本地接收到的消息计算得出，服务器不记录

Optional operationTime

operationTime?: number

会话操作时间

  • 5.8.4 版本开始，Electron 平台支持此参数，收发消息、设置置顶等操作将更新会话操作时间以用于会话排序。
  • 5.14.0 版本开始 Web 端支持此参数，仅收发消息时会更新。
  • 5.20.0 版本开始，Web 端增加内存状态维护，不再只有从服务器获取列表时返回。
since

5.8.4

Optional draft

draft?: string

会话草稿

Optional channelType

channelType?: UltraGroupChannelType

超级群频道类型

description

仅超级群会话支持

Optional firstUnreadMessage

firstUnreadMessage?: null | IUltraUnreadMsg

第一条未读消息

description
  • 该属性仅超级群会话支持，数据基于服务器记录，并依据接收到的消息进行本地维护
  • 自 5.20.0 版本开始，新增支持单群聊会话，数据基于本地接收到的消息计算得出，并在本地缓存和维护，服务器不记录

isTopInTag

isTopInTag: boolean