IRPCClientScript.DownloadScriptApplicationFile_Begin
Vault API / standard read session idempotent
Starts downloading the package (ZIP file) of an application and returns its first block.
| Service | Client scripts and UI extension applications MFiles.IRPCClientScript |
|---|---|
| gRPC method | /MFiles.IRPCClientScript/DownloadScriptApplicationFile_Begin |
| HTTP (mf-http-grpc) | POST /grpc/v1/download-script-application-file_-begin |
| Request | DownloadScriptApplicationFile_BeginRequest |
| Response | DownloadScriptApplicationFile_BeginResponse |
| 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
- Continue with
DownloadScriptApplicationFile_ReadBlock
from offset
len(data)untilfile_sizebytes have been read. If the first block already holds the whole file, the download is finished anddownload_idcannot be used. block_sizeis at most 4194304 (4 MiB); larger values fail with "Block size exceeded the limit of 4194304 bytes.". 0 returns no data.
Request: DownloadScriptApplicationFile_BeginRequest
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 |
|---|---|---|
script_application | string | The GUID of the application. |
block_size | uint32 | The number of bytes to return in data, at most 4 MiB. |
Response: DownloadScriptApplicationFile_BeginResponse
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, for the next blocks. |
file_size | int64 | The size of the package in bytes. |
data | bytes | The first block of the package. |
Related methods
- DownloadScriptApplicationFile_ReadBlock -- Reads the next block of an application download.
- DownloadScriptApplication -- Not implemented: fails with "Not implemented.".