IRPCIndexingDataSource.DownloadFile_ReadBlockForFIX
Server integration API / specialized internal: not for applications write session
Gets a specific block from a file from the server for file data indexing.
| Service | Indexing data source MFiles.IRPCIndexingDataSource |
|---|---|
| gRPC method | /MFiles.IRPCIndexingDataSource/DownloadFile_ReadBlockForFIX |
| HTTP (mf-http-grpc) | POST /grpc/v1/download-file_-read-block-for-fix |
| Request | DownloadFile_ReadBlockForFIXRequest |
| Response | DownloadFile_ReadBlockForFIXResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. Search indexers call it to read a block of a file opened with DownloadFile_BeginForFIX. Applications should not call it.
- Requires a vault session with the vault rights
see_all_objectsandsee_deleted_objects.
Request: DownloadFile_ReadBlockForFIXRequest
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 | Download session identifier. |
block_size | uint32 | The number of bytes wanted. |
offset | int64 | The offset to start reading from. |
Response: DownloadFile_ReadBlockForFIXResponse
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 | Block data. |
Related methods
- DownloadFile_BeginForFIX -- Begins downloading a file for file data indexing.
- DownloadFile_EndForFIX -- Ends downloading a file for file data indexing.