跳到主要内容

RefreshLock

POST /wopi/files/(file_id)

通过将文件的自动到期计时器重置为 30 分钟来刷新文件的锁定。此锁定将在 30 分钟后自动过期，除非它被 Unlock 或其他 RefreshLock 操作更改。

此操作的工作原理如下：

  1. WOPI 主机检查文件当前是否被锁定。
  2. 如果文件未被锁定，或者文件当前被锁定并且 X-WOPI-Lock 值与文件当前锁不匹配，则主机必须返回 409 Conflict ("lock mismatch") 并包含 X-WOPI-Lock 响应标头，标头中包含文件当前锁的值。在文件未被锁定的情况下，主机必须将 X-WOPI-Lock 设置为空字符串。
  3. 在文件被第三方客户端锁定的情况下，主机仍应始终在X-WOPI-Lock响应标头中包含当前锁ID。在文件被第三方客户端锁定的情况下，主机仍应始终在 X-WOPI-Lock 响应标头中包含当前锁 ID。

参数​

名称类型描述
file_idstringfile ID 必须是 URL 安全的文件 ID。

查询参数​

名称类型描述
access_tokenstring访问令牌主机将用它确定请求是否被授权。

请求标头​

名称类型是否必填描述
X-WOPI-Overridestring必填来自 WOPI 服务器的请求操作 (REFRESH_LOCK)。
X-WOPI-Lockstring必填锁ID主机必须用它来标识文件上的锁。

响应标头​

名称类型是否必填描述
X-WOPI-Lockstring非必填的锁ID标识文件上的当前锁。当使用 409 Conflict响应请求时，必须始终包含此标头。用 200 OK响应请求时不应包含它。
X-WOPI-LockFailureReasonstring非必填的锁定失败的原因。当使用 409 Conflict响应请求时，可能会包含此标头。它只能用于记录目的。