@polyv/chat 2.2.0-rc-20251113.1 → 2.3.0-rc-20251204.1

package/index.es.d.ts

@@ -4,6 +4,42 @@ import { EventEmitter } from '@polyv/utils/es/event';
 import { PolyvSocket } from '@polyv/socket';
 import { SocketUserType } from '@polyv/socket';
 
+declare class AskModule extends ChatModuleBase {
+    private __apiFilter;
+    constructor(plvChat: PolyvChat);
+    private __handleAskSocket;
+    /**
+     * 获取提问用户列表
+     */
+    getAskUserList(): Promise<AskUser[]>;
+    /**
+     * 获取提问历史消息
+     */
+    getAskHistory(options: GetAskHistoryOptions): Promise<AskMsgType[]>;
+    private __buildSocketData;
+    sendSpeakMsg(options: SendAskSpeakMsgOptions): Promise<void>;
+    sendImageMsg(options: SendAskImageMsgOptions): Promise<void>;
+    sendSystemMsg(options: SendAskSystemMsgOptions): Promise<void>;
+}
+
+/**
+ * 提问消息类型
+ */
+export declare type AskMsgType = ChatMsgSpeakType | ChatMsgImageType | ChatMsgSystemType;
+
+export declare interface AskUser {
+    /** 用户 id */
+    userId: string;
+    /** 昵称 */
+    nick: string;
+    /** 头像 */
+    pic: string;
+    /** 头衔 */
+    actor: string;
+    /** 最新消息的时间戳 */
+    lastMessageTime: number;
+}
+
 export declare interface AttendanceData extends ChatMessageUser {
     /**
      * 排序号
@@ -140,7 +176,7 @@ export declare interface ChatMessageUser<T extends SocketUserType = SocketUserTy
      */
     label?: {
         /** 提问区标签 */
-        question: string[];
+        question?: string[];
     };
 }
 
@@ -776,6 +812,13 @@ declare class FilterBase {
     _filterUser(user: ChatMessageUser): ChatMessageUser;
 }
 
+export declare interface GetAskHistoryOptions {
+    /**
+     * 目标用户 id
+     */
+    targetUserId: string;
+}
+
 export declare interface GetAttendanceDownloadRecordOptions {
     pageNumber?: number;
     pageSize?: number;
@@ -1215,6 +1258,13 @@ declare class OnlineModule extends ChatModuleBase {
      * @param options 获取选项
      */
     getOnlineList(options?: GetOnlineListOptions): Promise<OnlineListResult>;
+    /**
+     * 获取在线列表（观众）
+     */
+    private __getOnlineListByViewer;
+    /**
+     * 获取在线列表（搜索）
+     */
     private __getOnlineListByKeyword;
     /**
      * 获取在线列表（普通）
@@ -1296,7 +1346,7 @@ export declare class PolyvChat {
     status: StatusModule;
     /** 工具模块 */
     utils: UtilsModule;
-    /** 发送模块 */
+    /** 聊天消息发送模块 */
     sender: SenderModule;
     /** 管理模块 */
     manage: ManageModule;
@@ -1306,6 +1356,8 @@ export declare class PolyvChat {
     download: DownloadModule;
     /** 点赞模块 */
     like: LikeModule;
+    /** 提问模块 */
+    ask: AskModule;
     constructor(plvSocket: PolyvSocket, config?: PolyvChatConfig);
     /** 是否设置完成 */
     setuped: boolean;
@@ -1346,6 +1398,10 @@ export declare enum PolyvChatEvent {
      * 用户登录事件
      */
     UserLogin = "UserLogin",
+    /**
+     * 用户退出事件
+     */
+    UserLogout = "UserLogout",
     /**
      * 聊天消息事件
      */
@@ -1429,7 +1485,11 @@ export declare enum PolyvChatEvent {
     /**
      * 发送点赞
      */
-    SendChatLike = "SendChatLike"
+    SendChatLike = "SendChatLike",
+    /**
+     * 提问消息事件
+     */
+    AskMessage = "AskMessage"
 }
 
 export declare type PolyvChatEventRelations = {
@@ -1445,6 +1505,16 @@ export declare type PolyvChatEventRelations = {
          */
         user: ChatMessageUser;
     };
+    [PolyvChatEvent.UserLogout]: {
+        /**
+         * 用户 id
+         */
+        userId: string;
+        /**
+         * 用户昵称
+         */
+        nick: string;
+    };
     [PolyvChatEvent.ChatMessage]: {
         /**
          * 聊天消息对象
@@ -1605,6 +1675,16 @@ export declare type PolyvChatEventRelations = {
          */
         count: number;
     };
+    [PolyvChatEvent.AskMessage]: {
+        /**
+         * 提问消息
+         */
+        askMsg: AskMsgType;
+        /**
+         * 目标用户 id
+         */
+        targetUserId: string;
+    };
 };
 
 export declare interface PushMsgToQaOptions {
@@ -1682,6 +1762,54 @@ export declare interface ResultSuccessBasic {
     success: true;
 }
 
+export declare interface SendAskImageMsgOptions {
+    /**
+     * 图片 id
+     */
+    imageId: string;
+    /**
+     * 图片地址
+     */
+    imageUrl: string;
+    /**
+     * 图片尺寸
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * 目标用户 id
+     */
+    targetUserId?: string;
+}
+
+export declare interface SendAskSpeakMsgOptions {
+    /**
+     * 发言内容
+     */
+    content: string;
+    /**
+     * 目标用户 id
+     */
+    targetUserId?: string;
+}
+
+export declare interface SendAskSystemMsgOptions {
+    /**
+     * 系统消息类型
+     */
+    type?: SystemMsgType;
+    /**
+     * 消息内容
+     */
+    content: string;
+    /**
+     * 目标用户 id
+     */
+    targetUserId: string;
+}
+
 export declare interface SendCustomServerMsgOptions {
     /**
      * 自定义消息内容
@@ -1907,7 +2035,11 @@ export declare enum SystemMsgType {
     /**
      * 聊天区通知
      */
-    ChatRoomIntroduction = "chat-room-introduction"
+    ChatRoomIntroduction = "chat-room-introduction",
+    /**
+     * 违规词
+     */
+    ForbiddenWord = "forbidden-word"
 }
 
 export declare interface TopingMsgData {