IRPCWOPIOperationsPublic.WOPIDownloadFile_ReadBlock
Server integration API / specialized internal: not for applications write no session
Reads a block of the file of a WOPI download session.
| Service | WOPI operations (anonymous) MFiles.IRPCWOPIOperationsPublic |
|---|---|
| gRPC method | /MFiles.IRPCWOPIOperationsPublic/WOPIDownloadFile_ReadBlock |
| HTTP (mf-http-grpc) | POST /grpc/v1/wopidownload-file_-read-block |
| Request | WOPIDownloadFile_ReadBlockRequest |
| Response | WOPIDownloadFile_ReadBlockResponse |
| 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. Applications should not call it.
download_idmust belong to a download started with the same token's link; otherwise the call fails with an invalid shared link error.
Request: WOPIDownloadFile_ReadBlockRequest
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. |
download_id | int32 | The ID from WOPIDownloadFile_Begin. |
block_size | uint32 | The number of bytes wanted. |
offset | int64 | The offset to start reading from. |
Response: WOPIDownloadFile_ReadBlockResponse
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 |
|---|---|---|
data | bytes | Receives the data block. |
Related methods
- WOPIDownloadFile_Begin -- Starts downloading the file of a WOPI user session and returns its size and MD5 checksum.