IRPCClientScript.DownloadScriptApplicationFile_ReadBlock

View as Markdown

Vault API / standard read session idempotent

Reads the next block of an application download.

ServiceClient 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
RequestDownloadScriptApplicationFile_ReadBlockRequest
ResponseDownloadScriptApplicationFile_ReadBlockResponse
Book and levelVault API, standard
Kindread
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

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.

FieldTypeDescription
download_idint32The ID of the download.
block_sizeuint32The number of bytes to read, at most 4 MiB.
offsetint64The 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.

FieldTypeDescription
databytesThe bytes read; shorter than block_size at the end of the file.