文档

描述

文档部分允许更改与文档有关的所有参数（标题、url、文件类型等）。

示例

example.com 是安装文档管理器和文档存储服务的服务器的名称。请参阅工作原理部分，了解有关文档服务器服务客户端与服务器交互的更多信息。

            File type
            
            Key
            
                Reference data
            
                    File key
                    
                     Instance Id
                    
            Title
            
            URL

参数

名称	描述	类型	示例
fileType*	定义查看或编辑的源文档的文件类型。必须是小写。以下文件类型可用：.csv、.djvu、.doc、.docm、.docx、.docxf、.dot、.dotm、.dotx、.epub、.fb2、.fodp、.fods、.fodt、. htm、.html、.mht、.odp、.ods、.odt、.oform、.otp、.ots、.ott、.oxps、.pdf、.pot、.potm、.potx、.pps、.ppsm、 .ppsx、.ppt、.pptm、.pptx、.rtf、.txt、.xls、.xlsb、.xlsm、.xlsx、.xlt、.xltm、.xltx、.xml、.xps。	string	"docx"
key*	定义服务用来识别文档的唯一文档标识符。如果发送了已知key，则将从缓存中获取文档。每次编辑和保存文档时，都必须重新生成key。文档 url 可以用作 key，但不能使用特殊字符，长度限制为 128 个符号。	string	"Khirz6zTPdfd7"
可以使用的关键字符：0-9、 az、 AZ、 -._=。最大密钥长度为 128 个字符。
referenceData	定义一个由集成商生成的对象，用于唯一标识其系统中的文件： fileKey - 服务用来获取文件链接的唯一文档标识符。在编辑和保存文档时不得更改（即它不等于 document.key 参数），类型: string, 示例: "BCFA2CED"; instanceId - 唯一的系统标识符。如果数据从一个系统上的文件复制并插入到另一个系统的文件中，则通过链接粘贴将不可用，并且上下文菜单中没有相应的按钮，类型: string, 示例: "https://example.com"; key - 定义服务用于从共同编辑会话获取数据的唯一文档标识符。如果发送已知密钥，将从缓存中获取文档。每次编辑并保存文档时，都必须重新生成密钥。文档 url 可以用作key，但不能包含特殊字符，且长度限制为 128 个字符, 类型: string, 示例: "Khirz6zTPdfd7".	object	{ "fileKey": "BCFA2CED", "instanceId": "https://example.com", "key": "Khirz6zTPdfd7" }
title*	为查看或编辑的文档定义所需的文件名，该文件名也将在下载文档时用作文件名。长度限制为 128 个符号。	string	"Example Document Title.docx"
url*	定义存储查看或编辑的源文档的绝对 URL。使用本地链接时请务必添加令牌。否则会出现错误。	string	"https://example.com/url-to-example-document.docx"

* - 必填字段