常见问题
复制页面
石墨文档中台(SDK)
CO-1.4
>=CO-1.6
CO-1.5
CO-1.4
CO-1.2-1.3
<CO-1.2
一文认识石墨文档中台
文档中台支持的格式
10 分钟创建协同文档
10分钟创建预览文档
示例代码仓库
更新日志
典型场景案例
云盘场景
IM场景
接口文档
接口文档概览
错误码说明
石墨后端API
请求签名凭证
签名凭证类型
签名凭证-Signature
签名凭证-Token
系统管理
应用管理
获取应用详情
更新应用回调地址
用户席位管理
用户席位状态说明
获取用户列表和席位状态
激活用户席位
取消 用户席位
批量设置用户席位
协同文档创建删除
访问协同文档
创建协同文档
创建协同文档副本
删除协同文档
预览文件
访问预览文件
创建文件预览缓存
文档导入导出
文档导入
文档导入说明
创建导入任务
获取导入进度
创建导入任务(旧版)
获取导入进度(旧版)
文档导出
文档导出流程
创建导出任务
获取导出进度
文档操作
专业表格(Excel)
专业表格接口参数说明
获取表格内容
获取表格中的评论数
更新表格内容
追加表格内容
删除表格行
新增表格工作表
轻文档(Markdown)
获取文档中的评论列表
通用
获取文件纯文本内容
文件纯文本字数统计
获取历史列表
获取版本列表
获取文档内容中所有的at人信息列表
传统文档(Word)
传统文档书签说明
读取传统文档书签内容
替换传统文档书签内容
石墨前端API
【前端】JS-API
编辑器API
表单
应用表格
表格
轻文档
幻灯片
传统文档
回调接口(接入方需实现)
【后端】回调接口说明
【后端】回调总览
文件信息
获取文件元信息-协同文档
获取文件元信息-预览文档
获取当前用户的文件列表
获取文件的协作者列表
获取接入方指定文件的完整访问地址
获取文件元信息-协同文档自动任务(admin)
根据指定用户获取文件元信息-协同文档(admin)
用户信息
批量获取用户信息(admin)
获取当前用户信息
获取当前用户所在团队信息
获取指定用户信息
获取用户水印信息
获取用户部门路径
批量获取用户信息
团队和部门
获取团队下的成员列表
获取部门信息
获取部门的下级部门节点
获取部门下的成员分页列表
搜索功能
获取与文件相关的用户列表
获取与文件相关的文件列表
按关键字搜索文件和用户列表
消息推送
评论(Comment)
轻文档
添加评论
删除评论
结束评论
对于评论的回复评论
表格
添加评论
删除评论
结束评论
对于评论的回复评论
传统文档
添加评论
更新评论
删除评论
对于评论的回复评论
幻灯片
添加评论
删除评论
结束评论
对于评论的回复评论
应用表格
添加评论
对于评论的回复评论
删除评论
讨论(Discussion)
轻文档
发送讨论消息
提及(MentionAt @ 人)
轻文档
在评论中 at
在讨论中 at
在正文中 at
表格
在评论中 at
在正文中 at
传统文档
在评论中 at
在正文中 at
应用表格
在评论中 at
在正文中 at
日期提醒 (DateMention)
轻文档
创建
修改
删除
表格
创建
修改
删除
传统文档
创建
修改
删除
文件内容更新 (FileContent)
文件内容更新
文档协作者协同状态变化 (Collaborator)
文档协作者协同状态变化
版本 (Revision)
版本
系统事件 (System)
系统事 件
(实验性) 回调请求错误
回调请求错误
常见问题
复制粘贴、全屏操作不正常
如何实现文档模板功能
文档内容何时保存
移动端不支持blob协议导致预览失败
如何实现文件重命名
@人员时如何直接跳转至对应锚点
访问接口提示 signature 无效怎么办
文件预览或导入报错如何处理
首次接入 SDK 报错 应该排查哪些接口
文档预览如何做防盗链
如何通过接口修改文档内容
常见问题
复制页面
文档内容何时保存
石墨 SDK 的协同引擎会在用户输入后立即把增量 Operation 推送到石墨云端,并在所有协作者之间广播,因此无需手动保存。
工作机制:
编辑页面的内容状态「保存中/保存成功/保存失败」由 SDK 自动维护,接入方通过接入前端 saveStatusChanged 监听函数来对应展示编辑状态,对应状态值为「saving/saved/error」;只要保持 AppId、签名和网络有效,内容就会持续落盘。
服务端同时生成历史版本,可在界面中查看回溯,误操作也能快速恢复。
如果临时断网,SDK 会将尚未同步的操作排队,网络恢复后自动补发;若长时间无法补发,会提示用户刷新以避免冲突。
业务侧建议:
1.
如需在业务界面展示保存状态,可订阅 JSSDK 提供的同步状态事件(详见 npm README)或直接读取 SDK 的状态提示来提醒用户。
2.
在关闭窗口或切换路由前,可检测当前同步状态并在尚未完成时给予二次确认,确保用户知悉。
因此,大部分场景无需编写额外保存逻辑,把精力放在网络健康监控与错误提醒上即可。
修改于
2026-04-07 02:47:21
上一页
如何实现文档模板功能
下一页
移动端不支持blob协议导致预览失败