ObjID

Object ID.

Name	Description	Type
type	Object type.	number
item_id	The object item id.	ItemID

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

Properties

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

Creating Objects

// Create a new ObjID object with the specified type and internal ID.
const result = ObjID.Create(0, 0);

Working with Objects

// Extension helpers for ObjID instances
// Internal object ID.
const id = objidInstance.ID;
objidInstance.ID = 0;

// Object Type.
const type = objidInstance.Type;
objidInstance.Type = 0;

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

Example

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