CheckFileInfo

GET /wopi/files/(file_id)

返回有关文件属性、访问权限和编辑器设置的信息。

参数
名称 描述 类型
file_id 必须是 URL 安全的文件 ID。 string
查询参数
名称 描述 类型
access_token 访问令牌主机将用它来确定请求是否被授权。 string
请求标头
名称 描述 类型 出现
X-WOPI-SessionContext 会话上下文(如果在初始 WOPI 操作 URL 上提供)。 string 可选的
必需的响应属性
名称 描述 类型 示例
不带路径的文件名,显示在用户界面 (UI) 中并确定文件扩展名。 string "Example File Name.docx"
基于服务器文件版本架构的文件的当前版本。每次编辑和保存文档时,都必须更改版本。 给定文件的版本号不得重复。 string "Khirz6zTPdfd7"
面包屑导航属性
名称 描述 类型 示例
WOPI 客户端向用户显示的名称,用于指示 WOPI 服务器的品牌名称。 string "Example Brand Name"
当用户单击显示 BreadcrumbBrandName的 UI 时,WOPI 客户端导航到的网页的 URL。 string "https://example.com/url-to-breadcrumb-brand-page.com"
WOPI 客户端向用户显示的文件名。如果未指定此参数,则使用 BaseFileName 参数。 string "Example Breadcrumb File Name.docx"
WOPI 客户端向用户显示的名称,指示文件所在的文件夹的名称。 string "Example Folder Name"
当用户单击显示 BreadcrumbFolderName的 UI 时,WOPI 客户端导航到的网页的 URL。 string "https://example.com/url-to-breadcrumb-brand-folder"
PostMessage 属性
名称 描述 类型 示例
指定如果用户关闭当前使用此文件的正在渲染或编辑的客户端,WOPI客户端是否应通知WOPI服务器。 当online office的 Close UI 被激活时,主机期望收到 UI_Close PostMessage。 boolean true
指定如果用户尝试编辑文件,WOPI 客户端是否应通知 WOPI 服务器。 当online office的 Edit UI被激活时,主机期望收到 UI_Edit PostMessage。 boolean true
指定如果用户尝试编辑文件,WOPI 客户端是否应通知 WOPI 服务器。 主机希望收到 Edit_Notification PostMessage。 boolean true
指定如果用户尝试共享文件,WOPI 客户端是否应通知 WOPI 服务器。 当online office中的 Share UI 被激活时,主机期望收到 UI_Sharing PostMessage。 boolean true
指定如果用户尝试导航到以前的文件版本,WOPI 客户端是否将通知 WOPI 服务器。 当online office中的 Previous Versions UI 被激活时,主机期望收到 UI_FileVersions PostMessage。 boolean true
WOPI 客户端在发送消息时必须使用的域作为 targetOrigin 参数,如 [W3C-HTML5WEBMSG]中所述。 string "https://exampledomain.com"
文件 URL 属性
名称 描述 类型 示例
当用户关闭当前使用此文件的正在渲染或编辑的客户端时,实现者认为对用户有用的网页的URL。 string "https://example.com/url-to-close-page.com"
允许用户共享文件的位置的 URL。 string "https://example.com/url-to-sharing-page.com"
允许用户查看先前文件版本的位置的 URL。 string "https://example.com/url-to-previous-version-page.com"
可以使用 WOPI 客户端编辑文件的网页的 URL。 string "https://example.com/url-to-host-page.com"
其他杂项属性
名称 描述 类型 示例
指定 WOPI 客户端是否必须禁用应用程序中的复制和粘贴功能。 默认情况下,所有复制和粘贴功能均已启用,即该设置无效。 可能的属性值:
  • BlockAll - 复制和粘贴功能在应用程序中被完全禁用;
  • CurrentDocumentOnly - 复制和粘贴功能已启用,但只能在应用程序当前打开的文件中复制和粘贴内容。
string "BlockAll"
指定 WOPI 客户端是否必须禁用其控制下的任何打印功能。 boolean true
必须以"."开头的文件扩展名。 string ".docx"
WOPI服务器支持的文件名的最大长度,包括文件扩展名。 integer 20
上次修改文件的时间。此时间必须始终为UTC时间,并且必须以ISO 8601往返格式格式化。 此属性可以指定为Version属性的替代项。 string "2009-06-15T13:45:30.0000000Z"
用户元数据属性
名称 描述 类型 示例
指定用户是否匿名。 boolean true
一个用户名。如果未定义,则 WOPI 客户端可能被配置为在某些情况下使用占位符字符串,或者根本不显示名称。 string "John Smith"
由 WOPI 服务器指定的唯一用户标识符。 string "uid-1"
用户权限属性
名称 描述 类型 示例
指定当前用户是否不能更改文件。 boolean true
指定用户是否有权在 WOPI 服务器上创建新文件。 true 值意味着 PutRelativeFile 这个用户执行当前文件将失败。 默认情况下,此参数为 false 并执行 PutRelativeFile 操作。 boolean false
指定用户是否有权重命名文件。 boolean true
指定用户是否有权审阅文件。 boolean true
指定用户是否有权编辑文件。 boolean true
WOPI 主机功能属性
名称 描述 类型 示例
指定WOPI服务器是否支持lock, unlock, 和 refreshlock 操作。 boolean true
指定 WOPI 服务器是否支持重命名权限。 boolean true
指定 WOPI 服务器是否支持审阅权限。 boolean true
指定 WOPI 服务器是否支持 PutFilePutRelativeFile 操作。 boolean true
Nextcloud/Collabora/Seafile properties
名称 描述 类型 示例
指定是否启用调用UI_InsertGraphic 消息的菜单项和工具栏项。 此属性用于显示允许用户从集成中选择图像的用户界面元素(例如,对话框)。 该集成应该提供一个可以下载一次的临时 URL,通过将 Action_InsertGraphic 消息的Values 设置为临时 URL,将其返回。 boolean true
指定 WOPI 服务器是否从 UI 的文件菜单栏中隐藏打印选项。 boolean false