IRPCObjectOperations.DownloadFile_Stop
Vault API / core read session or assertion idempotent
Closes a download session.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/DownloadFile_Stop |
| HTTP (mf-http-grpc) | POST /grpc/v1/download-file_-stop |
| Request | DownloadFile_StopRequest |
| Response | DownloadFile_StopResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Closing a session that does not exist, for example one the server already closed after the last block was read, succeeds.
Request: DownloadFile_StopRequest
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 session. |
Response: DownloadFile_StopResponse
No fields.
Related methods
- DownloadFile_ReadBlock -- Reads a block of a file from a download session.
- DownloadFile_Begin -- Opens a download session for a file version and returns its ID, the content size and, on request, its MD5 checksum.
- DownloadFile -- Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.