IRPCClientScript.DownloadScriptApplicationFile_ReadBlock
Vault API / standard read session idempotent
Reads the next block of an application download.
| Service | Client scripts and UI extension applications MFiles.IRPCClientScript |
|---|---|
| gRPC method | /MFiles.IRPCClientScript/DownloadScriptApplicationFile_ReadBlock |
| HTTP (mf-http-grpc) | POST /grpc/v1/download-script-application-file_-read-block |
| Request | DownloadScriptApplicationFile_ReadBlockRequest |
| Response | DownloadScriptApplicationFile_ReadBlockResponse |
| Book and level | Vault API, standard |
| Kind | read |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Read the blocks in order. The download is removed after the read that reaches the end of the file; later reads fail with "Not found. (The specified download session ... does not exist.)".
- Also reads downloads started with GetDownloadSessionIdOfScriptApplicationFile.
Request: DownloadScriptApplicationFile_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 |
|---|---|---|
download_id | int32 | The ID of the download. |
block_size | uint32 | The number of bytes to read, at most 4 MiB. |
offset | int64 | The byte offset to read from. |
Response: DownloadScriptApplicationFile_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 | The bytes read; shorter than block_size at the end of the file. |
Related methods
- GetDownloadSessionIdOfScriptApplicationFile -- Starts downloading one file of a UI extension application of the new M-Files clients.
- DownloadScriptApplicationFile_Begin -- Starts downloading the package (ZIP file) of an application and returns its first block.
- DownloadScriptApplication -- Not implemented: fails with "Not implemented.".