IRPCSharedLinksPublic.DownloadSharedFile_ReadBlock
Vault API / standard write no session
Reads one block of a file download started with DownloadSharedFile_Begin.
| Service | Shared links (anonymous access) MFiles.IRPCSharedLinksPublic |
|---|---|
| gRPC method | /MFiles.IRPCSharedLinksPublic/DownloadSharedFile_ReadBlock |
| HTTP (mf-http-grpc) | POST /grpc/v1/download-shared-file_-read-block |
| Request | DownloadSharedFile_ReadBlockRequest |
| Response | DownloadSharedFile_ReadBlockResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- No session is needed.
access_keymust be the key that started the download; another key fails with "The link is either expired or invalid.". block_sizecan be at most 4 MiB (4 194 304 bytes). Read until you havefile_sizebytes; a block can be shorter than requested. See Files for block sizes and message size limits.
Request: DownloadSharedFile_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 |
|---|---|---|
vault | string | The vault GUID. |
access_key | string | The access key that started the download. |
download_id | int32 | The download_id from DownloadSharedFile_Begin. |
block_size | uint32 | The number of bytes to read, at most 4 194 304. |
offset | int64 | The position in the file to read from. |
Response: DownloadSharedFile_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. |
Related methods
- DownloadSharedFile_Begin -- Starts downloading the file of a shared link, without logging in, and returns a download ID, the file size and its MD5 checksum.