guide云服务常见问题解答

# 如何更新编辑器捆绑包?

编辑器捆绑包是预配置和可立即使用的 CKEditor 5 的源代码,已压缩并构建为单个文件。要使用文档存储、导入和导出或连接优化功能,您需要将应用程序中的编辑器文件的精确副本上传到 CKEditor 云服务服务器。

有关编辑器捆绑包的更多信息,请点击这里

为了确保数据一致性,建议在编辑器发生任何更改时更新编辑器捆绑包。

有关如何更新编辑器捆绑包的说明,请查看文档

# 如何更新编辑器?

在更新前端应用程序中的 CKEditor 5 后,您可能会在连接到文档时收到检测到不兼容的捆绑包版本或引擎版本错误。这意味着文档是使用旧版本的编辑器创建的。在这种情况下,您需要创建一个新的协作会话才能继续使用该文档。

无法使用两个或多个不同版本的编辑器来编辑文档。

要创建新的协作会话,您可以断开所有用户的连接,并在 24 小时后重新连接。或者,您可以使用我们的REST API 方法以编程方式结束打开的协作会话。

# 如何检测不兼容的捆绑包版本?

要检查用于初始化编辑会话的捆绑包版本,您可以向我们的REST API发出请求。

在响应中,您将收到bundle_version,可以将其与当前的捆绑包版本进行比较。

如果捆绑包版本不同,用户将无法使用新编辑器连接到文档。在这种情况下,您可以刷新协作会话,但请记住,刷新它会使使用旧编辑器已连接的用户的文档失效。您可以使用专门的 REST API 方法检查是否有人仍然连接。

# 如何恢复损坏的文档?

有时,由于某些无效操作,文档可能会损坏。它们可能是由自定义插件、使用无效的捆绑包版本等引起的。在这种情况下,您将收到一条错误消息,提示无法以当前状态访问文档。某些操作无法正确保存

恢复此类文档的唯一方法是通过REST API 端点将其恢复到最新的工作版本。此方法将删除导致文档损坏并阻止其保存的操作。

恢复过程将刷新当前的协作会话(如果存在)并删除阻止文档保存的操作。请记住,此操作会导致最近的更改丢失

# 如何保存文档?

CKEditor 云服务提供 3 种保存文档的方法。默认情况下,我们的服务不会永久存储客户文档。要执行此操作,您需要启用文档存储功能

您还可以使用我们的REST API 方法将文档存储在您自己的存储中。

第三种方法是借助自动保存插件直接从前端应用程序保存文档。

有关更多详细信息,包括对可用保存方法的比较,请查看我们的文档

# 如何导出文档的内容?

创建文档后,您可以向我们的 REST API 发出请求以获取其内容。结果,您将收到包含插件添加数据的自定义标签的 HTML。

您可以在专用部分中找到有关导出文档内容的更多信息。

# 如何以编程方式创建文档?

默认情况下,第一个用户连接到文档时就会创建该文档。但是,您可以使用先前导出的文档内容在任何用户连接到文档之前导入文档。

有关导入文档内容的更多信息,请查看我们的文档

# 如何获取评论?

评论内容及其元数据保存在数据库中。文档内容包含带有评论 ID 的标签,这些标签引用数据库中的数据。

您可以通过向我们的REST API发出请求来获取所选评论的内容。还可以获取给定文档中的所有评论

# 如何获取建议?

建议嵌入在给定文档的内容中,位于专用标签内。数据库只包含元数据,例如建议的状态、作者等。

您可以通过向我们的REST API发出请求来获取建议元数据。

# 如何删除给定环境中的所有数据?

CKEditor 云服务将某些数据保存在持久数据库中。但是,删除给定环境时,所有这些数据都会被清除。

有关如何删除环境的说明,请查看专用部分

此操作后,所有计费数据将保持不变,监控数据将在 30 天后自动删除。

# 如何重新发送 Webhook?

在某些情况下(例如,webhook 目标服务器发生错误),您可能需要手动重新发送 webhook 请求。要执行此操作,请访问 SaaS 的CKEditor 生态系统客户仪表板或 On-Premises 应用程序的管理面板中的Webhook部分。

从创建的 webhook 列表中,选择您感兴趣的 webhook。接下来,在请求列表中,找到您要重新发送的请求。选择请求后,单击重新发送请求按钮,然后在随后的弹出窗口中确认操作。

# userIddocumentId 等标识符区分大小写吗?

所有标识符(例如userIddocumentId 等)都区分大小写。这意味着,例如user1User1将被视为两个不同的用户。唯一的例外是针对 MySQL 的 CKEditor 协作服务器本地安装(版本最高为4.12.1),这些安装不区分大小写。

# 从不区分大小写的 CKEditor 协作服务器本地安装迁移到区分大小写的 CKEditor 协作服务器本地安装

如果您想从不区分大小写的安装迁移,您可以在版本高于4.12.1的版本上设置一个新的 CKEditor 协作服务器本地安装,并使用导出导入 REST API 端点来迁移您的内容。简单地将旧的 CKEditor 协作服务器本地安装更新到4.12.1以上版本并不会将实例转换为区分大小写。相反,需要进行新的安装并使用迁移过程。