IRPCSharedLinksPublic.DownloadSharedFile_Begin

Vault API / standard write no session

Starts downloading the file of a shared link, without logging in, and returns a download ID, the file size and its MD5 checksum.

Service	Shared links (anonymous access) `MFiles.IRPCSharedLinksPublic`
gRPC method	`/MFiles.IRPCSharedLinksPublic/DownloadSharedFile_Begin`
HTTP (mf-http-grpc)	`POST /grpc/v1/download-shared-file_-begin`
Request	`DownloadSharedFile_BeginRequest`
Response	`DownloadSharedFile_BeginResponse`
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. For links shared with named visitors, pass the visitor values in additional_data (see the service overview).
Then read the content with DownloadSharedFile_ReadBlock, sending the same vault and access_key.
The MD5 checksum is split in two: the 16 checksum bytes are the 8 bytes of low_digest followed by the 8 bytes of high_digest, each in little-endian order.
Co-authoring links cannot be downloaded ("The parameter is incorrect.").

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 of the shared link.
`additional_data[]`	repeated `NamedValue`	Optional named values; see GetSharedLinkInfo.
`additional_data[].key`	`string`	The name of the value.
`additional_data[].value`	`TypedValue`	The value as a serialized bytearray.
`additional_data[].value.is_null_value`	`bool`	True if the value is empty. `data` is then unset.
`additional_data[].value.type`	`Datatype`	The data type of the value.
`additional_data[].value.data`	`TypedValueUnion`	The value, in the member that matches `type`. Unset for an empty value.

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 download session ID for DownloadSharedFile_ReadBlock.
`file_size`	`int64`	The size of the file in bytes.
`low_digest`	`int64`	The first 8 bytes of the MD5 checksum, as a little-endian integer.
`high_digest`	`int64`	The last 8 bytes of the MD5 checksum, as a little-endian integer.

DownloadSharedFile_ReadBlock -- Reads one block of a file download started with DownloadSharedFile_Begin.