easemob-websdk 4.24.1 → 5.0.0

package/types/connection.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 连接相关类型定义
+ */
+/**
+ * [zh-CN] 连接状态常量。
+ * [en-US] Connection status constants.
+ */
+export declare const ConnectionStatus: {
+    readonly DISCONNECTED: "disconnected";
+    readonly CONNECTING: "connecting";
+    readonly CONNECTED: "connected";
+    readonly RECONNECTING: "reconnecting";
+    readonly RECONNECT_FAILED: "reconnectFailed";
+};
+/**
+ * [zh-CN] SDK 连接状态。
+ * [en-US] SDK connection status.
+ */
+export type ConnectionStatus = (typeof ConnectionStatus)[keyof typeof ConnectionStatus];
+/**
+ * [zh-CN] 连接事件名称常量。
+ * [en-US] Connection event name constants.
+ */
+export declare const ConnectionEventName: {
+    readonly CONNECTING: "onConnecting";
+    readonly CONNECTED: "onConnected";
+    readonly DISCONNECTED: "onDisconnected";
+    readonly RECONNECT_FAILED: "onReconnectFailed";
+    readonly TOKEN_WILL_EXPIRE: "onTokenWillExpire";
+    readonly TOKEN_EXPIRED: "onTokenExpired";
+    readonly OFFLINE_MESSAGE_SYNC_START: "onOfflineMessageSyncStart";
+    readonly OFFLINE_MESSAGE_SYNC_FINISH: "onOfflineMessageSyncFinish";
+};
+/**
+ * [zh-CN] 连接事件名称。
+ * [en-US] Connection event name.
+ */
+export type ConnectionEventName = (typeof ConnectionEventName)[keyof typeof ConnectionEventName];
+/** @internal 内部事件名称常量。 */
+export declare const InternalEventName: {
+    readonly SEND_TIMEOUT: "onSendTimeout";
+    readonly GROUP_NOTIFY: "onGroupNotify";
+    readonly CHATROOM_NOTIFY: "onChatRoomNotify";
+    readonly CHAT_THREAD_NOTIFY: "onChatThreadNotify";
+    readonly USER_INFO_NOTIFY: "onUserInfoNotify";
+    readonly MESSAGE_SENT: "__internal:onMessageSent";
+};
+/** @internal 内部事件名称类型。 */
+export type InternalEventName = (typeof InternalEventName)[keyof typeof InternalEventName];
+/**
+ * [zh-CN] 连接状态变化原因常量。
+ * [en-US] Connection state change reason constants.
+ */
+export declare const ConnectionEventReason: {
+    readonly LOGIN: "login";
+    readonly RECONNECT: "reconnect";
+    readonly ONLINE: "online";
+    readonly OFFLINE_RECOVER: "offline-recover";
+    readonly HEARTBEAT_FAILED: "heartbeat-failed";
+    readonly SEND_TIMEOUT: "send-timeout";
+    readonly CLOSE: "close";
+    readonly ERROR: "error";
+    readonly TIMEOUT: "timeout";
+    readonly LIMIT: "limit";
+    readonly OFFLINE: "offline";
+    readonly TOKEN_EXPIRED: "token-expired";
+};
+/**
+ * [zh-CN] 连接状态变化原因。
+ * [en-US] Reason for a connection state change.
+ */
+export type ConnectionEventReason = (typeof ConnectionEventReason)[keyof typeof ConnectionEventReason];
+/**
+ * [zh-CN] 连接事件载荷。
+ * [en-US] Connection event payload.
+ */
+export interface ConnectionEventPayload {
+    /** [zh-CN] 当前连接状态。 [en-US] Current connection status. */
+    readonly state: ConnectionStatus;
+    /** [zh-CN] 触发本次事件的原因。 [en-US] Reason that triggered this event. */
+    readonly reason: ConnectionEventReason;
+    /** [zh-CN] 当前重连尝试次数。 [en-US] Current reconnection attempt number. */
+    readonly attempt: number;
+    /** [zh-CN] 允许的最大重连次数。 [en-US] Maximum allowed reconnection attempts. */
+    readonly maxAttempts: number;
+    /** [zh-CN] 是否处于登录阶段。 [en-US] Whether the SDK is in the login phase. */
+    readonly isLoginPhase: boolean;
+    /** [zh-CN] 当前网络是否在线。 [en-US] Whether the network is currently online. */
+    readonly isOnline: boolean;
+    /** [zh-CN] 触发事件的错误码。 [en-US] Error code that triggered the event. */
+    readonly errorCode?: number;
+    /** [zh-CN] 触发事件的错误消息。 [en-US] Error message that triggered the event. */
+    readonly errorMessage?: string;
+    /** [zh-CN] 事件时间戳，单位毫秒。 [en-US] Event timestamp in milliseconds. */
+    readonly timestamp: number;
+}
+/**
+ * [zh-CN] 消息发送超时事件载荷。
+ * [en-US] Message send timeout event payload.
+ */
+export interface SendTimeoutEventPayload {
+    /** [zh-CN] 固定为发送超时原因。 [en-US] Always the send-timeout reason. */
+    readonly reason: typeof ConnectionEventReason.SEND_TIMEOUT;
+    /** [zh-CN] 事件时间戳，单位毫秒。 [en-US] Event timestamp in milliseconds. */
+    readonly timestamp: number;
+}
+/**
+ * [zh-CN] Token 生命周期事件载荷；此类事件不携带 token 或鉴权信息。
+ * [en-US] Token lifecycle event payload; these events do not include token or authentication data.
+ */
+export type TokenLifecycleEventPayload = undefined;

package/types/contact.d.ts

@@ -0,0 +1,149 @@
+/**
+ * [zh-CN] 好友自动同步相关公共类型定义，供 ContactManager、事件系统与文档生成复用。
+ * [en-US] Public type definitions for friend auto-sync, shared across ContactManager, event system, and doc generation.
+ */
+import type { ErrorCode } from '../utils/error-codes';
+import type { UserInfo } from './user-info';
+/**
+ * [zh-CN] 好友展示对象。
+ * [en-US] Friend view object.
+ */
+export interface Contact {
+    /** [zh-CN] 好友用户 ID。 [en-US] The user ID of the friend. */
+    readonly userId: string;
+    /** [zh-CN] 好友资料视图，直接复用统一 `UserInfo`。 [en-US] Friend profile view, backed by the shared `UserInfo` model. */
+    readonly userInfo: UserInfo;
+    /** [zh-CN] 当前用户给该好友的备注。 [en-US] Remark set by the current user for this friend. */
+    readonly remark: string;
+    /** [zh-CN] 好友关系建立时间戳。 [en-US] Timestamp when the friend relationship was established. */
+    readonly addTs: number;
+}
+/**
+ * [zh-CN] 好友资料变化事件载荷。
+ * [en-US] Payload for friend profile change events.
+ */
+export interface ContactInfoUpdatedEvent {
+    /** [zh-CN] 最新好友资料。 [en-US] The latest friend profile. */
+    readonly userInfo: UserInfo;
+    /** [zh-CN] 当前会话中可用的好友快照。 [en-US] Friend snapshot if available in the current conversation. */
+    readonly contact?: Contact;
+}
+/**
+ * [zh-CN] 好友写操作的统一目标。
+ * [en-US] Unified target object for friend mutation APIs.
+ */
+export interface ContactMutationTarget {
+    /** [zh-CN] 目标用户 ID。 [en-US] Target user ID. */
+    readonly userId: string;
+}
+/**
+ * [zh-CN] 添加好友的输入参数。
+ * [en-US] Input parameters for adding a friend.
+ */
+export interface AddContactParams extends ContactMutationTarget {
+    /** [zh-CN] 可选的验证消息。 [en-US] Optional verification message. */
+    readonly message?: string;
+}
+/**
+ * [zh-CN] 更新好友备注的输入参数。
+ * [en-US] Input parameters for updating a friend's remark.
+ */
+export interface SetContactRemarkParams extends ContactMutationTarget {
+    /** [zh-CN] 好友备注，允许空字符串以清空备注。 [en-US] Friend remark. An empty string clears the remark. */
+    readonly remark: string;
+}
+/**
+ * [zh-CN] 黑名单增删接口的输入参数。
+ * [en-US] Input parameters for block list mutation APIs.
+ */
+export interface BlocklistMutationParams {
+    /** [zh-CN] 待处理的用户 ID 列表。 [en-US] List of user IDs to mutate. */
+    readonly userIds: ReadonlyArray<string>;
+}
+/**
+ * [zh-CN] 黑名单添加成功结果。
+ * [en-US] Result of a successful block list addition.
+ */
+export interface BlocklistAddResult {
+    /** [zh-CN] 成功加入黑名单的用户资料列表。 [en-US] List of profiles belonging to users that were successfully added to the block list. */
+    readonly succeeded: ReadonlyArray<UserInfo>;
+    /** [zh-CN] 加入失败的用户资料列表。 [en-US] List of profiles belonging to users that failed to be added to the block list. */
+    readonly failed: ReadonlyArray<UserInfo>;
+}
+/**
+ * [zh-CN] 会话级黑名单快照。
+ * [en-US] conversation-scoped block list snapshot.
+ */
+export interface BlocklistSnapshot {
+    /** [zh-CN] 当前黑名单条目列表。 [en-US] List of current block list entries. */
+    readonly items: ReadonlyArray<UserInfo>;
+    /** [zh-CN] 当前会话是否已完成服务端加载。 [en-US] Whether the server-side block list data is loaded in the current conversation. */
+    readonly loaded: boolean;
+    /** [zh-CN] 快照来源。 [en-US] Snapshot source. */
+    readonly source: 'server' | 'mutation_patch';
+}
+/**
+ * [zh-CN] 好友 roster 事件的标准化公开载荷。
+ * [en-US] Normalized public payload for contact roster events.
+ */
+export interface ContactRosterEventPayload {
+    /** [zh-CN] 事件发送方用户 ID。 [en-US] User ID of the event sender. */
+    readonly from: string;
+    /** [zh-CN] 事件接收方用户 ID。 [en-US] User ID of the event recipient. */
+    readonly to: string;
+    /** [zh-CN] 服务端附带的邀请附言或事件原因。 [en-US] Invitation message or event reason provided by the server. */
+    readonly message: string;
+    /** [zh-CN] 事件目标用户的资料视图；对外事件会在派发前补齐，至少包含 `userId`。 [en-US] Profile view of the event target. It is enriched before public dispatch and always includes at least `userId`. */
+    readonly userInfo: UserInfo;
+}
+/**
+ * [zh-CN] 好友快照来源。
+ * [en-US] Source of a friend snapshot.
+ */
+export type ContactSyncSource = 'cache' | 'sync';
+/**
+ * [zh-CN] 好友同步决策结果。
+ * [en-US] Decision result for friend sync.
+ */
+export type ContactSyncDecision = 'skip' | 'incremental' | 'full';
+/**
+ * [zh-CN] 好友同步失败阶段。
+ * [en-US] Failure stage of friend sync.
+ */
+export type ContactSyncStage = 'metadata' | 'socket_connect' | 'sync_page' | 'decode' | 'cancelled';
+/**
+ * [zh-CN] 好友快照，包含列表、来源、版本和完整性信息。
+ * [en-US] Friend snapshot containing list, source, version, and completeness metadata.
+ */
+export interface ContactSnapshot {
+    /** [zh-CN] 当前快照中的好友列表。 [en-US] List of friends in the current snapshot. */
+    readonly items: ReadonlyArray<Contact>;
+    /** [zh-CN] 当前快照来自缓存还是同步结果。 [en-US] Whether the snapshot comes from cache or sync result. */
+    readonly source: ContactSyncSource;
+    /** [zh-CN] 当前快照对应的好友版本号。 [en-US] Friend version associated with the snapshot. */
+    readonly version: string;
+    /** [zh-CN] 当前快照是否可作为完整好友结果使用。 [en-US] Whether the snapshot is complete enough to serve as the full friend result. */
+    readonly complete: boolean;
+}
+/**
+ * [zh-CN] 好友同步错误对象。
+ * [en-US] Friend sync error object.
+ */
+export interface ContactSyncError {
+    /** [zh-CN] SDK 错误码。 [en-US] SDK error code. */
+    readonly code: ErrorCode;
+    /** [zh-CN] 错误发生阶段。 [en-US] Stage where the error occurred. */
+    readonly stage: ContactSyncStage;
+    /** [zh-CN] 面向调用方的错误消息。 [en-US] Error message intended for the caller. */
+    readonly message: string;
+    /** [zh-CN] 当前错误是否建议重试。 [en-US] Whether retry is recommended for this error. */
+    readonly retryable: boolean;
+}
+/**
+ * [zh-CN] 好友同步内部完成载荷；公开同步事件已统一到 ChatClient 级 `onSyncDataFinished`。
+ * [en-US] Internal payload for friend sync completion. Public sync events are unified under the ChatClient-level `onSyncDataFinished` event.
+ */
+export interface ContactSyncFinishPayload {
+    /** [zh-CN] 失败时返回错误详情。 [en-US] Error details if the sync failed. */
+    readonly error: ContactSyncError;
+}

package/types/conversation.d.ts

@@ -0,0 +1,270 @@
+/**
+ * [zh-CN] Conversation 公开类型定义。
+ * [en-US] Public conversation type definitions.
+ */
+import type { Sender } from './sender';
+import type { Message, MessageDirect, MessageModifiedInfo, MessageSendStatus, MessageType } from './index';
+export type { Sender } from './sender';
+export declare const CONVERSATION_TYPE: {
+    readonly SINGLE_CHAT: "singleChat";
+    readonly GROUP_CHAT: "groupChat";
+    readonly CHAT_ROOM: "chatRoom";
+};
+/**
+ * [zh-CN] 会话类型。
+ * [en-US] Conversation type.
+ */
+export type ConversationType = (typeof CONVERSATION_TYPE)[keyof typeof CONVERSATION_TYPE];
+/**
+ * [zh-CN] 会话标记槽位常量，实际业务含义由开发者维护。
+ * [en-US] Conversation mark slot constants (value range: 0-19); the actual business meaning is defined and maintained by the application layer.
+ */
+export declare const CONVERSATION_MARK: {
+    readonly MARK_0: 0;
+    readonly MARK_1: 1;
+    readonly MARK_2: 2;
+    readonly MARK_3: 3;
+    readonly MARK_4: 4;
+    readonly MARK_5: 5;
+    readonly MARK_6: 6;
+    readonly MARK_7: 7;
+    readonly MARK_8: 8;
+    readonly MARK_9: 9;
+    readonly MARK_10: 10;
+    readonly MARK_11: 11;
+    readonly MARK_12: 12;
+    readonly MARK_13: 13;
+    readonly MARK_14: 14;
+    readonly MARK_15: 15;
+    readonly MARK_16: 16;
+    readonly MARK_17: 17;
+    readonly MARK_18: 18;
+    readonly MARK_19: 19;
+};
+/**
+ * [zh-CN] 会话标记槽位，取值范围为 0 至 19。
+ * [en-US] Conversation mark slot with a value from 0 to 19.
+ */
+export type ConversationMark = (typeof CONVERSATION_MARK)[keyof typeof CONVERSATION_MARK];
+/**
+ * [zh-CN] 会话唯一标识。
+ * [en-US] Unique conversation identifier.
+ */
+export interface ConversationIdentifier {
+    /** [zh-CN] 会话 ID：单聊时为对方用户 ID，群聊时为群组 ID，聊天室时为聊天室 ID。 [en-US] Conversation ID: User ID for one-to-one chats, group ID for group chats, or chat room ID for chat rooms. */
+    readonly conversationId: string;
+    /** [zh-CN] 会话类型。 [en-US] Conversation type. */
+    readonly conversationType: ConversationType;
+}
+/**
+ * [zh-CN] 设置或移除会话标记时的会话定位参数。
+ * [en-US] Conversation locator used when setting or removing conversation marks.
+ */
+export type ConversationMarkTarget = ConversationIdentifier;
+/**
+ * [zh-CN] 会话列表查询过滤条件。
+ * [en-US] Filter criteria for querying the conversation list.
+ */
+export interface ConversationFilter {
+    /** [zh-CN] 若为 true，则仅返回已置顶的会话。 [en-US] If true, the SDK returns only pinned conversations. */
+    readonly isPinned?: boolean;
+    /** [zh-CN] 按会话标记槽位过滤，取值范围 0 至 19。 [en-US] Filters by conversation mark slot. The value range is 0-19. */
+    readonly mark?: ConversationMark;
+}
+/**
+ * [zh-CN] 删除会话的操作参数。
+ * [en-US] Parameters for deleting a conversation.
+ */
+export interface DeleteConversationParams extends ConversationIdentifier {
+    /** [zh-CN] 是否同时删除服务端存储的漫游消息。 [en-US] Whether to also delete the roaming messages stored on the server. */
+    readonly deleteRoamingMessages?: boolean;
+}
+/**
+ * [zh-CN] 设置会话置顶状态的操作参数。
+ * [en-US] Parameters for setting the pinned status of a conversation.
+ */
+export interface SetConversationPinnedParams extends ConversationIdentifier {
+    /** [zh-CN] `true` 表示置顶，`false` 表示取消置顶。 [en-US] `true`： pins the conversation, `false`： unpins the conversation. */
+    readonly pinned: boolean;
+}
+/**
+ * [zh-CN] 添加或移除会话标记的参数，支持单个会话或批量会话。
+ * [en-US] Parameters for adding or removing conversation marks, supporting either a single conversation or batch conversations.
+ */
+export type ConversationMarkParams = {
+    /** [zh-CN] 需要操作的会话列表。 [en-US] List of conversations to operate on. */
+    readonly conversations: ReadonlyArray<ConversationMarkTarget>;
+    /** [zh-CN] 会话标记槽位，取值范围 0 至 19。 [en-US] Conversation mark slot. The valid range is 0-19. */
+    readonly mark: ConversationMark;
+} | (ConversationIdentifier & {
+    /** [zh-CN] 会话标记槽位，取值范围 0 至 19。 [en-US] Conversation mark slot. The valid range is 0-19. */
+    readonly mark: ConversationMark;
+});
+/**
+ * [zh-CN] 单个会话的标记变更结果。
+ * [en-US] Result of a mark mutation operation for a single conversation.
+ */
+export interface ConversationMarkMutationItem extends ConversationIdentifier {
+    /** [zh-CN] 操作失败原因；成功项不包含该字段。 [en-US] Failure reason; this field is omitted for successful operations. */
+    readonly reason?: string;
+}
+/**
+ * [zh-CN] 会话标记变更结果。
+ * [en-US] Result of a batch conversation mark mutation operation.
+ */
+export interface ConversationMarkMutationResult {
+    /** [zh-CN] 成功应用标记变更的会话。 [en-US] Conversations with mark change successfully applied. */
+    readonly succeeded: ReadonlyArray<ConversationMarkMutationItem>;
+    /** [zh-CN] 未能应用标记变更的会话。 [en-US] Conversations that failed to apply the mark change. */
+    readonly failed: ReadonlyArray<ConversationMarkMutationItem>;
+    /** [zh-CN] 本次操作涉及的标记槽位。 [en-US] The mark slot involved in this operation. */
+    readonly mark: ConversationMark;
+    /** [zh-CN] 标记操作类型：添加或移除。 [en-US] Mark operation type: add or remove. */
+    readonly operation: 'addMark' | 'removeMark';
+}
+/**
+ * [zh-CN] 置顶或取消置顶消息的参数。
+ * [en-US] Parameters for pinning or unpinning a message.
+ */
+export interface PinMessageParams extends ConversationIdentifier {
+    /** [zh-CN] 待操作的消息 ID。 [en-US] ID of the message to pin or unpin. */
+    readonly messageId: string;
+}
+/**
+ * [zh-CN] 获取会话内置顶消息列表的参数。该接口不分页，最多返回 20 条置顶消息。
+ * [en-US] Parameters for retrieving the list of pinned messages in a conversation. This API does not support pagination and returns a maximum of 20 pinned messages.
+ */
+export type GetPinnedMessageListParams = ConversationIdentifier;
+/**
+ * [zh-CN] 会话变更结果。
+ * [en-US] Conversation mutation result.
+ */
+export interface ConversationMutationResult {
+    /** [zh-CN] 会话 ID。 [en-US] Conversation ID. */
+    readonly conversationId: string;
+    /** [zh-CN] 会话类型。 [en-US] Conversation type. */
+    readonly conversationType: ConversationType;
+    /** [zh-CN] 操作类型：删除或置顶切换。 [en-US] Operation type: delete or toggle pin status. */
+    readonly operation: 'delete' | 'setPinned';
+    /** [zh-CN] 会话的置顶状态。 [en-US] Whether the conversation is pinned. */
+    readonly isPinned?: boolean;
+    /** [zh-CN] 置顶时间戳，单位毫秒。 [en-US] Timestamp when the item was pinned.*/
+    readonly pinnedTime?: number;
+}
+/**
+ * [zh-CN] 置顶或取消置顶消息的结果。
+ * [en-US] Result of pinning or unpinning a message.
+ */
+export interface MessagePinMutationResult {
+    /** [zh-CN] 会话 ID。 [en-US] Conversation ID. */
+    readonly conversationId: string;
+    /** [zh-CN] 会话类型。 [en-US] Conversation type. */
+    readonly conversationType: ConversationType;
+    /** [zh-CN] 消息 ID。 [en-US] Message ID. */
+    readonly messageId: string;
+    /** [zh-CN] 操作类型：置顶或取消置顶。 [en-US] Operation type: pin or unpin. */
+    readonly operation: 'pin' | 'unpin';
+}
+/**
+ * [zh-CN] 置顶消息的摘要信息。
+ * [en-US] Summary of a pinned message.
+ */
+export interface PinnedMessageSummary {
+    /** [zh-CN] 消息 ID。 [en-US] Message ID. */
+    readonly messageId: string;
+    /** [zh-CN] 会话 ID。 [en-US] Conversation ID. */
+    readonly conversationId: string;
+    /** [zh-CN] 会话类型。 [en-US] Conversation type. */
+    readonly conversationType: ConversationType;
+    /** [zh-CN] 置顶操作者用户 ID。 [en-US] User ID of the operator who pinned message. */
+    readonly operatorId?: string;
+    /** [zh-CN] 置顶时间戳（毫秒）。 [en-US] Timestamp when the message was pinned, in milliseconds. */
+    readonly pinnedAt: number;
+    /** [zh-CN] 被置顶的完整消息。 [en-US] Full pinned message. */
+    readonly message: Message;
+}
+/**
+ * [zh-CN] 会话内置顶消息摘要列表，最多包含 20 条。
+ * [en-US] Pinned message summaries in the conversation, up to 20 items.
+ */
+export interface PinnedMessageListResult {
+    /** [zh-CN] 置顶消息摘要列表。 [en-US] Pinned message summaries. */
+    readonly items: ReadonlyArray<PinnedMessageSummary>;
+}
+/**
+ * [zh-CN] 主动刷新新会话列表时的参数。
+ * [en-US] Parameters for manually refreshing the conversation list.
+ */
+export interface RefreshSessionListParams {
+    /** [zh-CN] 是否需要返回空会话。（无消息的会话）。 [en-US] Whether to return empty conversations (conversations without any messages). */
+    readonly includeEmpty?: boolean;
+}
+/**
+ * [zh-CN] 会话列表专用的消息提醒类型。
+ * [en-US] Notification reminder type specific to the conversation list.
+ */
+export type SessionListRemindType = 'DEFAULT' | 'ALL' | 'AT' | 'NONE';
+/**
+ * [zh-CN] 会话列表最小消息摘要。
+ * [en-US] Minimal message snippet used by the conversation list.
+ */
+export interface SessionMessageSnippet {
+    /** [zh-CN] 服务端消息 ID。 [en-US] Message ID on the server. */
+    readonly msgServerId: string;
+    /** [zh-CN] 消息发送者的用户 ID。 [en-US] User ID of the message sender. */
+    readonly from: string;
+    /** [zh-CN] 消息接收方 ID：单聊时为对方用户 ID，群聊时为群组 ID，聊天室时为聊天室 ID。 [en-US] Message recipient ID: user ID for one-to-one chat, group ID for group chat, or chat room ID for chat room. */
+    readonly to: string;
+    /** [zh-CN] 发送者信息。 [en-US] Message sender information. */
+    readonly sender: Sender;
+    /** [zh-CN] 会话 ID。 [en-US] Conversation ID. */
+    readonly conversationId?: string;
+    /** [zh-CN] 会话类型。 [en-US] Conversation type. */
+    readonly conversationType?: ConversationType;
+    /** [zh-CN] 消息类型。 [en-US] Message type. */
+    readonly type?: MessageType;
+    /** [zh-CN] 消息发送状态。 [en-US] Message sending status. */
+    readonly sendStatus?: MessageSendStatus;
+    /** [zh-CN] 消息时间戳（毫秒）。 [en-US] Message timestamp, in milliseconds. */
+    readonly timestamp: number;
+    /** [zh-CN] 消息方向：发送或接收。 [en-US] Message direction: outgoing or incoming. */
+    readonly direct?: MessageDirect;
+    /** [zh-CN] 消息修改信息；当最后一条消息被编辑后，此字段可能存在。 [en-US] Message modification information; present when the last message has been edited. */
+    readonly modifiedInfo?: MessageModifiedInfo;
+    /** [zh-CN] 发送者用户资料的版本时间戳（秒），用于资料补全。 [en-US] User profile version timestamp (in seconds) of the message sender, used for profile hydration. */
+    readonly userInfoUpdateTime?: number;
+    /** [zh-CN] 群成员名片的版本时间戳（秒），仅群聊会话的最后一条消息可能存在此字段。 [en-US] The version timestamp (in seconds) of the Group member name card. This field may only exist for the last message in group chat conversations. */
+    readonly namecardUpdateTime?: number;
+    /** [zh-CN] 消息体摘要，不包含 `type` 字段。 [en-US] Message body summary without the `type` field. */
+    readonly body: Record<string, unknown>;
+}
+/**
+ * [zh-CN] 公开的会话列表项，来自本地会话列表缓存的投影数据。
+ * [en-US] Public conversation list item, projected from the local conversation list cache.
+ */
+export interface ConversationItem {
+    /** [zh-CN] 会话 ID。 [en-US] Conversation ID. */
+    readonly conversationId: string;
+    /** [zh-CN] 会话类型。 [en-US] Conversation type. */
+    readonly conversationType: ConversationType;
+    /** [zh-CN] 会话的未读消息数量。 [en-US] Unread message count for this conversation. */
+    readonly unreadCount: number;
+    /** [zh-CN] 最后一条消息摘要。 [en-US] Summary of the last message in the conversation. */
+    readonly lastMessage: SessionMessageSnippet | null;
+    /** [zh-CN] 最后一条消息的时间戳（毫秒）。 [en-US] Timestamp of the last message in milliseconds. */
+    readonly lastMessageAt?: number;
+    /** [zh-CN] 会话是否处于置顶状态。 [en-US] Whether the conversation is pinned. */
+    readonly isPinned?: boolean;
+    /** [zh-CN] 置顶时间戳（毫秒）。 [en-US] Timestamp when the conversation is pinned, in milliseconds. */
+    readonly pinnedTimestamp?: number;
+    /** [zh-CN] 会话已应用的标记列表。 [en-US] List of marks applied to the conversation. */
+    readonly marks: ReadonlyArray<ConversationMark>;
+    /** [zh-CN] 已读位置或已读时间戳。 [en-US] Read receipt position or read timestamp. */
+    readonly readAt?: number;
+    /** [zh-CN] 会话的提醒类型。 [en-US] Notification reminder type for the conversation. */
+    readonly remindType: SessionListRemindType;
+    /** [zh-CN] 会话的显示名称。 [en-US] Display name of the conversation. */
+    readonly conversationName: string;
+    /** [zh-CN] 会话的头像 URL 地址。 [en-US] Avatar URL of the conversation. */
+    readonly conversationAvatar?: string;
+}