Skip to main content

IRuntimeDMObjects Methods

An object defining methods for the IRuntimeDMObjects class.

RemoveByPath(path)

Removes a DmObject from the runtime collection by its file path.

Parameters:

path (required): string
The file path of the DmObject to remove.

Returns:

Type: DmObject

This is a sync method. Method runs synchronously.


Get(id)

Retrieves a DmObject by its unique identifier.

Parameters:

id (required): long
The unique identifier of the document management object to retrieve.

Returns:

Type: DmObject

This is a sync method. Method runs synchronously.


AddOrUpdate(obj)

Adds or updates a DmObject in the runtime document management collection.

Parameters:

obj (required): DmObject
The DmObject to add or update.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


GetByPath(path)

Retrieves a DmObject by its file path.

Parameters:

path (required): string
The file path of the document management object to retrieve.

Returns:

Type: DmObject

This is a sync method. Method runs synchronously.


Remove(id)

Removes a DmObject from the runtime collection by its unique identifier.

Parameters:

id (required): long
The unique identifier of the DmObject to remove.

Returns:

Type: DmObject

This is a sync method. Method runs synchronously.


GetVersionIds()

Retrieves a dictionary mapping document IDs to their version IDs.

Returns:

Type: Dictionary<long, long>

This is a sync method. Method runs synchronously.