ItemID

Item ID. Can be used to represent any item identity, that can be located natively in M-Files or in external system. E.g. value list item id or object id.

Name	Description	Type
internal_id	Internal ID (>= 1 for a valid object).	number
external_repository_id	The item id in external repository.	ExternalRepositoryID

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 ItemID object with the specified internal ID.	id: number	ItemID

Properties

Property	Type	Description
ID	number	Internal object ID.
IsExternal	boolean	Is the object external?

Creating Objects

// Create a new ItemID object with the specified internal ID.
const result = ItemID.Create(0);

Working with Objects

// Extension helpers for ItemID instances
// Internal object ID.
const id = itemidInstance.ID;
itemidInstance.ID = 0;

// Is the object external?
const isexternal = itemidInstance.IsExternal;

Example

{
  "internal_id": 0,
  "external_repository_id": {
    "connection": "<connection>",
    "item": "<item>"
  }
}