FileUploadWholeHeader
The first message of the FileUploadWhole request stream.
| Full name | MFiles.FileUploadWholeHeader |
|---|---|
| Proto file | mfiles/IRPCFileTransferStreaming.proto |
Fields
| Field | Type | Number | Description |
|---|---|---|---|
obj_id | ObjID | 1 | The id of the object to which the file is bound, if attaching immediately. If set, together with file, attach the content to this object's file immediately. If not set, the content is only stored as a stateless temp file, retrievable later via the returned file_ref, using a separate FileUploadAttach call. obj_id and file must either both be set or both be omitted. |
file | File | 2 | Information about the uploaded file, if attaching immediately. |
file_size | uint64 | 3 | The size of the whole file content in bytes. Required. The content must be exactly this size. Zero means an empty file. The server uses the size to reject a file that exceeds the maximum upload size before any content is sent, and to stream the content forward as it is received. |
Used by methods
- IRPCFileTransferStreaming.FileUploadWhole -- Uploads a whole file by streaming its content.
Used in fields
FileUploadWholeRequest.header-- The first message of the stream. Describes the upload.