QChat 客户端

此软件包包含一个Q语言服务器的聊天客户端,可以嵌入到网页视图中. 用这个 迈纳维 生成基于网络的聊天界面.

通讯

聊天客户端通过主机应用程序( 如 IDE 扩展) 进行通信 postMessage 访问网页视图的请求 :

• 当主机应用程序发送请求时,客户端会处理消息并发送给UI
• 当一个事件在 UI 中被触发时,客户端会通过 postMessage 创建聊天客户端的主机应用程序

主办环境

网页视图由不同的IDE主机所嵌入,它们使用不同的浏览器引擎并不同地加载聊天资产. 因此 event.origin 在入境时观察到 postMessage 事件为 没有 整个主机的制服 :

由于来源不统一,入境消息处理器在防御上验证它:它只拒绝一个真实的HTTP(S)交叉发端消息并允许空出, "null",以及 file:// 来源,由合法主机生产(例如Windows上的Eclipse,其中) Browser.setText()-被注射的HTML有不透明的来源). 对入境信件处理或来源验证的任何更改 必须对上面每个主机环境进行验证 ——见: handleInboundMessage JSDoc 输入 src/client/chat.ts。 。 。 .

使用量

要使用聊天客户端, 将它嵌入您的应用程序中的网页视图并处理 postMessage 视需要进行沟通。 聊天客户端基于入境(从目的地到聊天客户端)和出境事件(从聊天客户端到目的地). 活动包括: command 财务报告和审定财务报表 params数字 :

interface SomeEvent {
    command: string;
    params: SomeOptions;
}

入境事件

外部事件

配置

当创建网络视图内部的聊天时, 配置可以作为明确的参数被传递, 例如 :

amazonQChat.createChat(acquireVsCodeApi(), configuration);

配置值 :

// Configures quick actions
quickActionCommands?: QuickActionCommandGroup[]

// Configures chat client not to show legal disclaimer as it has already been acknowledged before
disclaimerAcknowledged?: boolean