API reference
API reference
Select your platform
No SDKs available
No versions available

AssetFile

Updated: Oct 30, 2025

AssetFile

class AssetFile
The Asset File API provides methods for managing asset files in a virtual environment. The methods include getting details and status horizon.platform.assetfile.models.AssetDetails.downloadStatus, downloading by ID or name, canceling downloads, and deleting files by ID or name.

Constructors

NameSummary
AssetFile
constructor()

Types

NameSummary
Companion
object Companion

Functions

NameSummary
delete
suspend fun delete(assetFileId: String): AssetFileDeleteResult
The API has been deprecated. Please use AssetFile.delete_by_id() instead.
deleteById
suspend fun deleteById(assetFileId: String): AssetFileDeleteResult
Removes a previously installed asset file from the device by its ID. Returns an object containing the asset ID and file name, and a success flag.
deleteByName
suspend fun deleteByName(assetFileName: String): AssetFileDeleteResult
Removes a previously installed asset file from the device by its name. Returns an object containing the asset ID and file name, and a success flag.
download
suspend fun download(assetFileId: String): AssetFileDownloadResult
The API has been deprecated. Please use AssetFile.download_by_id() instead.
downloadById
suspend fun downloadById(assetFileId: String): AssetFileDownloadResult
Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic horizon.platform.assetfile.AssetFile.downloadUpdate to track the downloads.
downloadByName
suspend fun downloadByName(assetFileName: String): AssetFileDownloadResult
Downloads an asset file by its name on demand. Returns an object containing the asset ID and filepath. Sends periodic {notifications.asset_file.download_update}} to track the downloads.
downloadCancel
suspend fun downloadCancel(assetFileId: String): AssetFileDownloadCancelResult
The API has been deprecated. Please use AssetFile.download_cancel_by_id() instead.
downloadCancelById
suspend fun downloadCancelById(assetFileId: String): AssetFileDownloadCancelResult
Cancels a previously spawned download request for an asset file by its ID. Returns an object containing the asset ID and file path, and a success flag.
downloadCancelByName
suspend fun downloadCancelByName(assetFileName: String): AssetFileDownloadCancelResult
Cancels a previously spawned download request for an asset file by its name. Returns an object containing the asset ID and file path, and a success flag.
downloadUpdate
fun downloadUpdate(): Flow<AssetFileDownloadUpdate>
Sent to indicate download progress for asset files.
getList
suspend fun getList(): List<AssetDetails>
Returns an array of asset details with asset file names and their associated IDs horizon.platform.assetfile.models.AssetDetails.assetId, and whether it’s currently installed horizon.platform.assetfile.models.AssetDetails.downloadStatus.
status
suspend fun status(assetFileId: String): AssetDetails
The API has been deprecated. Please use AssetFile.status_by_id() instead.
statusById
suspend fun statusById(assetFileId: String): AssetDetails
Returns the details horizon.platform.assetfile.models.AssetDetails on a single asset: ID, file name, and whether it’s currently installed
statusByName
suspend fun statusByName(assetFileName: String): AssetDetails
Returns the details horizon.platform.assetfile.models.AssetDetails on a single asset: ID, file name, and whether it’s currently installed

Companion

object Companion