IRPCWOPIOperationsPublic.GetLockForWOPI
Server integration API / specialized internal: not for applications write no session
Gets the WOPI lock string of the file of a WOPI user session.
| Service | WOPI operations (anonymous) MFiles.IRPCWOPIOperationsPublic |
|---|---|
| gRPC method | /MFiles.IRPCWOPIOperationsPublic/GetLockForWOPI |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-lock-for-wopi |
| Request | GetLockForWOPIRequest |
| Response | GetLockForWOPIResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. The M-Files WOPI service calls it to implement the WOPI lock operations. Applications should not call it.
- The token's user needs read and edit access to the object. Read-only.
- The WOPI lock is a string that Office for the web sets; it is separate from the M-Files check-out state.
Request: GetLockForWOPIRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
wopi_user_session_key | string | The WOPI user session token. |
Response: GetLockForWOPIResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
info | WOPILock | The current lock string in lock; empty when there is no lock. |
info.lock | string | The WOPI lock key. |