@handrail-chat/客户端
框架不可知核心 手推车 - 一个应用 帮助表面显示客户在您的产品中求取帮助, 代理商回答 斯莱克.
如果您正在使用 React 构建, 请安装
@handrail-chat/react
换句话说. 它取决于这个包 并给你一个面板,一个发射器和
钩子. 这个是用来建立自己的UI, 或者一个约束另一个框架.
bun add @handrail-chat/client
没有运行时间依赖 .
它给你什么
import { createHandrail, createSseTransport } from "@handrail-chat/client";
const handrail = createHandrail({
transport: createSseTransport({
baseUrl: "https://api.handrail.chat",
getToken: async () => (await fetch("/api/handrail-token")).json().then((r) => r.token),
}),
});
handrail.subscribe(() => render(handrail.getState()));
await handrail.start();
await handrail.send("my export keeps failing");
getState() 返回信件、对话、连接状态和状态.
subscribe 每变一变,就放火 这里没有州立图书馆,也没有
强迫你.
参见 React 包的 README 的令牌合同——你的后端需要的 和为什么.
运输接合
Transport 是两个执行的接口. SseTransport 与一个
真正的手推车; MockTransport 是内存,不需要服务器、数据库或
斯莱克 运输线上没有任何东西能把他们分辨出来,这就是我们
在测试和故事中可以从固定装置中驱动相同的组件.
import { createMockTransport } from "@handrail-chat/client";
const transport = createMockTransport();
const handrail = createHandrail({ transport });
transport.receiveAgentMessage("Looking into it now");
代理人的背景
有两种方式告诉Slack里的人 客户没有打字. 也没有向顾客展示过 React 软件包的 README 覆盖了两者 以一个完整的例子.
// An outcome the agent must not miss. Its own Slack message; works with the
// panel closed and on a resolved conversation.
await handrail.postNote('👍 "Exchanging tickets" solved it', { conversationId });
// What the customer is doing while they talk. Grey lines in one growing Slack
// message; sent only while the panel is open and the conversation unresolved.
handrail.setPanelOpen(true); // from your panel, as it opens and closes
handrail.trackActivity({ kind: "page", text: "Order #1234", url: location.href });
trackActivity 永不扔出并返回任何信息: 事件被分批处理
4分之1秒,失败的发送被放弃而不是重审.
页:1
实时更新使用 fetch 有溪流,没有 EventSource - 后者
无法设置信头, 从而将会话符号强制为查询字符串
在访问日志和浏览器历史中登陆.
start() 从不拒绝所以不用等就可以打电话了 如果
部件无法连接 - 您 getToken 扔出,否则网络会倒塌..
status 实值 "error" 财务报告和审定财务报表 error {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}说为什么 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}它用背面来重复 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}直到
它会的。 打开辅助发射器 status,而不是关于是否 start()
解决.
重新连接到三角洲而不是整个历史.
送信很乐观 由客户端生成的id调节,所以没有
当服务器的回声到达时重复 。 发送失败保留状态标记
failed 联合国 clientId,准备 retry。 。 。 .
许可证
尚未开放源代码.