Skip to main content

Interface: MediaLibraryEntity

Represents a base entity in the media management system.

MediaLibraryEntity serves as the foundation for all content stored in the media library, whether files or directories. It provides core metadata and organizational properties that enable efficient content management, search, and retrieval across the platform.

An effective media library is critical for businesses to maintain their digital assets, ensure consistent brand presentation, and streamline workflows by making the right assets available at the right time to the right users.

Extended by​

Properties​

createdDate?​

optional createdDate: null | number | Date

Timestamp indicating when this entity was first created.

This property helps track the creation history of media assets and can be used for sorting, filtering, and auditing purposes. It's particularly valuable for content governance and compliance requirements that involve tracking asset lifecycles.

Format: May be provided as a Date object, Unix timestamp in milliseconds, or null if the creation date is unknown.

directoryPath​

directoryPath: string

Relative path to the directory containing this entity.

This path defines the organizational location of the entity within the media library structure. It's used for navigation, browsing, and maintaining hierarchical relationships between entities. The path is typically relative to the root of the media storage system.

history​

history: History

Comprehensive history information for this entity.

Contains detailed audit data including who created the entity, who last modified it, and timestamps for these events. This history provides accountability and traceability for media assets, which is crucial for collaborative workflows and compliance requirements.

id​

id: string

Unique identifier for this media entity.

This ID is used to reference the entity throughout the system and remains consistent even if the entity is renamed or moved. It serves as the primary key for database operations and API calls related to this entity.

isInSystemFolder​

isInSystemFolder: boolean

Indicates whether this entity resides in a system-managed folder.

System folders contain critical assets used by the platform itself and often have special handling requirements and protection against deletion or modification. Assets in system folders typically support core platform functionality rather than being user-managed content.

When true, applications should apply appropriate restrictions to prevent accidental modification or deletion of system-critical assets.

label​

label: string

Display name of the media entity.

This human-readable name appears in the media library interface and is used for searching and identification. Unlike the underlying filename or path, the label can be customized to be more descriptive and user-friendly.

lastModifiedDate?​

optional lastModifiedDate: null | number | Date

Timestamp indicating when this entity was last modified.

Used to track when changes were made to the entity, enabling applications to identify recently updated content and implement proper caching strategies. For files, this typically indicates when the content was last updated.

Format: May be provided as a Date object, Unix timestamp in milliseconds, or null if the modification date is unknown.

revisionsNumber?​

optional revisionsNumber: number

Number of revisions stored for this entity.

For files with version history support, this indicates how many previous versions are available. This allows for tracking changes, reverting to previous versions, and maintaining an audit trail of asset evolution.

type​

type: "file" | "dir"

Specifies whether this entity is a file or directory.

This property determines how the entity is handled, displayed, and interacted with throughout the system. Directories can contain other entities, while files represent the actual assets.

  • 'file': An individual asset such as an image, document, or 3D model
  • 'dir': A container for organizing other files and directories