IRPCWOPIOperationsPublic.WOPIDownloadFile_ReadBlock

View as Markdown

Server integration API / specialized internal: not for applications write no session

Reads a block of the file of a WOPI download session.

ServiceWOPI operations (anonymous) MFiles.IRPCWOPIOperationsPublic
gRPC method/MFiles.IRPCWOPIOperationsPublic/WOPIDownloadFile_ReadBlock
HTTP (mf-http-grpc)POST /grpc/v1/wopidownload-file_-read-block
RequestWOPIDownloadFile_ReadBlockRequest
ResponseWOPIDownloadFile_ReadBlockResponse
Book and levelServer integration API, specialized
Kindwrite
SessionNot needed: the call can be made before logging in.
Idempotentno
Returns metadata structure versionno
Streamingnone (unary)

Remarks

For M-Files components only. The M-Files WOPI service calls it. Applications should not call it.

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.

FieldTypeDescription
wopi_user_session_keystringThe WOPI user session token.
download_idint32The ID from WOPIDownloadFile_Begin.
block_sizeuint32The number of bytes wanted.
offsetint64The 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.

FieldTypeDescription
databytesReceives the data block.