Interface: AssetFile
Represents a file asset in the media library.
AssetFile extends MediaLibraryEntity to provide detailed information specific to file assets such as images, documents, videos, and 3D models. It includes properties related to the file's content, format, and storage characteristics.
Well-managed file assets are essential for product visualization, marketing materials, documentation, and other customer-facing content. They enable consistent brand experiences and provide the visual and informational elements that drive engagement and conversions.
Extends
Properties
createdDate?
optionalcreatedDate: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.
Inherited from
MediaLibraryEntity.createdDate
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.
Inherited from
MediaLibraryEntity.directoryPath
extension
extension:
string
File format extension (without the dot).
Identifies the file format and helps determine how the file should be processed, displayed, and used. Common examples include 'jpg', 'png', 'pdf', 'docx', etc. The extension is crucial for determining file compatibility with different systems and applications.
filePath
filePath:
string
Full file path within the storage system.
This path provides the complete location information needed to access the file's content. It combines the directory path with the file name and extension, creating a unique identifier for the file within the 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.
Inherited from
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.
Inherited from
isImage
isImage:
boolean
Indicates whether this file is an image.
When true, this file is recognized as an image that can be displayed
directly in interfaces and used in image-specific workflows. Images
often receive special handling like thumbnailing, resizing, and format
conversion that doesn't apply to other file types.
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.
Inherited from
MediaLibraryEntity.isInSystemFolder
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.
Inherited from
lastModifiedDate?
optionallastModifiedDate: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.
Inherited from
MediaLibraryEntity.lastModifiedDate
revisionsNumber?
optionalrevisionsNumber: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.
Inherited from
MediaLibraryEntity.revisionsNumber
s3_path
s3_path:
string
Legacy storage path for the file.
Deprecated
Use filePath instead. This property is maintained for backward compatibility with older integrations but should not be used in new code.
size
size:
number
Size of the file in bytes.
This information helps applications manage storage quotas, optimize download processes, and provide appropriate loading indicators. It's critical for managing bandwidth usage and ensuring smooth user experiences when working with large files like high-resolution images or 3D models.
status
status:
Status
Current activation status of the file.
Indicates whether the file is currently active (available for use) or inactive (temporarily hidden from normal usage). This allows for temporarily removing files from circulation without deleting them, which is useful for seasonal content or items undergoing revision.
type
type:
"file"
Specifies that this entity is a file (not a directory).
This property is specifically set to 'file' for all AssetFile instances, differentiating them from directory entities in the media library.