File

A file of an object version: its identity and version, name, size, times and checksum.

Full name	`MFiles.File`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`file_ver`	`FileVer`	1	The file and its version. Pass it unchanged in an `ObjFileVer` to download the file.
`title`	`string`	2	The file name without the extension.
`extension`	`string`	3	The file name extension without the dot, for example "pdf".
`size`	`int64`	4	The size of the file in bytes. Exact when `size_precision` is `FILE_SIZE_PRECISION_EXACT`.
`size_precision`	`FileSizePrecision`	5	How exact `size` is. Do not rely on `size` if it is `FILE_SIZE_PRECISION_UNKNOWN`.Values: `FILE_SIZE_PRECISION_EXACT` (0), `FILE_SIZE_PRECISION_ESTIMATE` (1), `FILE_SIZE_PRECISION_UNKNOWN` (2).
`created_at_utc`	`google.protobuf.Timestamp`	6	The time in UTC the file was originally created.
`accessed_at_utc`	`google.protobuf.Timestamp`	7	The time in UTC the file was last accessed (e.g. read).
`written_at_utc`	`google.protobuf.Timestamp`	8	The time in UTC the file was last written to.
`changed_at_utc`	`google.protobuf.Timestamp`	9	The time in UTC the file was last written to or its attributes were changed.
`guid`	`string`	10	GUID of the file.
`md5_checksum`	`string`	11	The MD5 checksum of the file as 32 lowercase hexadecimal digits, if available.
`is_missing`	`bool`	12	True, if the file is missing.
`is_content_volatile`	`bool`	13	True, if the file physical content is volatile. I.e. the physical content can change without the version number change, as long as the logical content is same. The file content is guaranteed to stay physically consistent within single download session only.
`flags`	`OBJECTFILEFLAGS`	14	Object file flags.
`master_storage_file_ref`	`string`	15	An optional File reference (GUID) to external Master Storage API. Only used with Master Storage, otherwise empty.

Used by methods

IRPCDocumentOperationsFileIOInternal.UploadFileCommit2 -- Completes an upload made with UploadFile and stores it as the new content of the file; returns only the data file version.
IRPCFileTransfer.FileUploadAttach -- Stores an ended upload as the new content of an existing file of an object that is checked out to the caller.
IRPCObjectOperations.GetFileMalwareInfo -- Gets the malware scanning verdict of a file, as an advisory hint for a user interface.
IRPCObjectOperations.GetObjectFiles -- Gets the files of a specific object version.
IRPCObjectOperations.GetObjectFilesForModificationInEventHandler -- Gets the files of a checked-out object version for modification by an event handler. Used by server-side vault applications; requires the vault-level right to edit and delete all objects.
IRPCObjectOperations.UploadFile -- Uploads a block of new content for an existing file of an object that is checked out to the caller.
IRPCObjectOperations.UploadFileCommit -- Completes an upload made with UploadFile and stores it as the new content of the file.
IRPCSensitivityLabels.GetSensitivityLabels -- Gets the sensitivity labels of one file, or an empty list when no labels are available.

Used in fields

ObjectVersion.files -- The files of this version. Each file_ver can be passed to DownloadFile_Begin.
ObjVerInfoForMIX.files -- Object files.
WOPIContainerFile.file -- Object file.
UploadFileCommit2Request.file -- The file and its new size. title, extension and allocation_size are ignored.
FileUploadAttachRequest.file -- The file to replace, with the file_ver of the checked-out version and the exact size of the upload.
FileUploadWholeHeader.file -- Information about the uploaded file, if attaching immediately.
GetObjectFilesResponse.files -- The files of the version, with their IDs, versions, sizes and MD5 checksums.
UploadFileRequest.file -- The file to replace, as returned for the checked-out version: at least file_ver, and the new size with size_precision FILE_SIZE_PRECISION_EXACT.
UploadFileCommitRequest.file -- The file and its new size. title and extension are ignored.
GetObjectFilesForModificationInEventHandlerResponse.files -- Results.
GetFileMalwareInfoRequest.file -- The file to check,. Only pwszMasterStorageFileRef is read.
GetSensitivityLabelsRequest.file -- The file to query. Only master_storage_file_ref and extension are read.