FileVer

Document file.

Name	Description	Type
file_id	File identity.	FileID
type	The type of file version this struct represents.	FileVerType
internal_version	The file version.	number
external_repository_version	The file version identifier in external repository.	string
external_repository_sort_key	Sort key which provides ordering for external file versions.	number

Helper Methods and Properties

⚠️ Note

These helper methods and properties are available when using the npm package @m-filescorporation/uix-vault-messages. Install it in your project to use these helpers. For more information, see Overview/VaultMessages/.

Factory Methods

Method	Description	Parameters	Returns
Create	Create a new FileVer object with the specified ID and Version.	id: number version: number	FileVer

Properties

Property	Type	Description
ID	number | null
Version	number

Creating Objects

// Create a new FileVer object with the specified ID and Version.
const result = FileVer.Create(0, 0);

Working with Objects

// Extension helpers for FileVer instances
// Access ID extension property
const id = fileverInstance.ID;
fileverInstance.ID = 0;

// Access Version extension property
const version = fileverInstance.Version;
fileverInstance.Version = 0;

Example

{
  "file_id": {
    "type": 3 /* Enum: FileIDType */,
    "internal_id": 0,
    "external_repository_id": "<external repository id>"
  },
  "type": 3 /* Enum: FileVerType */,
  "internal_version": 0,
  "external_repository_version": "<external repository version>",
  "external_repository_sort_key": 0
}