API reference

AssetFile Class

Modifiers: final

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

deleteById ( assetFileId )	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. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.DeleteFailed. Signature suspend fun deleteById(assetFileId: String): AssetFileDeleteResult Parameters `assetFileId: String` Returns `AssetFileDeleteResult` The asset file ID and file name, and a success flag.
deleteByName ( assetFileName )	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. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.DeleteFailed. Signature suspend fun deleteByName(assetFileName: String): AssetFileDeleteResult Parameters `assetFileName: String` Returns `AssetFileDeleteResult` The asset file ID and file name, and a success flag.
downloadById ( assetFileId )	Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic AssetFile.downloadUpdate to track the downloads. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.DownloadFailed. Signature suspend fun downloadById(assetFileId: String): AssetFileDownloadResult Parameters `assetFileId: String` Returns `AssetFileDownloadResult` The asset file ID and file path, and a success flag.
downloadByIdList ( assetFileIdList )	Downloads a list of asset files by their IDs on demand. Returns a session ID that can be used to track the batch download progress. All assets must succeed or fail together. Sends periodic AssetFile.downloadUpdate to track the downloads. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.DownloadFailed. Signature suspend fun downloadByIdList(assetFileIdList: List<String>): Int Parameters `assetFileIdList: List` Returns `Int` Session ID for tracking the batch download, or -1 on failure
downloadByName ( assetFileName )	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. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.DownloadFailed. Signature suspend fun downloadByName(assetFileName: String): AssetFileDownloadResult Parameters `assetFileName: String` Returns `AssetFileDownloadResult` The asset file ID and file path, and a success flag.
downloadByNameList ( assetFileNameList )	Downloads a list of asset files by their names on demand. Returns a session ID that can be used to track the batch download progress. All assets must succeed or fail together. Sends periodic {notifications.asset_file.download_update}} to track the downloads. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.DownloadFailed. Signature suspend fun downloadByNameList(assetFileNameList: List<String>): Int Parameters `assetFileNameList: List` Returns `Int` Session ID for tracking the batch download, or -1 on failure
downloadCancel ( assetFileId ) DeprecatedAssetFile.download_cancel_by_id()	This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.CancelFailed. Signature suspend fun downloadCancel(assetFileId: String): AssetFileDownloadCancelResult Parameters `assetFileId: String` Returns `AssetFileDownloadCancelResult` The asset file ID and file path, and a success flag.
downloadCancelById ( assetFileId )	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. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.CancelFailed. Signature suspend fun downloadCancelById(assetFileId: String): AssetFileDownloadCancelResult Parameters `assetFileId: String` Returns `AssetFileDownloadCancelResult` The asset file ID and file path, and a success flag.
downloadCancelByName ( assetFileName )	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. This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled, AssetFileStatusCode.CancelFailed. Signature suspend fun downloadCancelByName(assetFileName: String): AssetFileDownloadCancelResult Parameters `assetFileName: String` Returns `AssetFileDownloadCancelResult` The asset file ID and file path, and a success flag.
downloadUpdate ()	Sent to indicate download progress for asset files. This method can return the following status codes: common status codes in AssetFileStatusCode. Signature fun downloadUpdate(): Flow<AssetFileDownloadUpdate> Returns `Flow<AssetFileDownloadUpdate>` The asset file ID, download progress, and download status.
getList ()	Returns an array of asset details with asset file names and their associated IDs AssetDetails.assetId, and whether it's currently installed AssetDetails.downloadStatus. This method can return the following status codes: common status codes in AssetFileStatusCode. Signature suspend fun getList(): List<AssetDetails> Returns `List` An array of asset details.
status ( assetFileId ) DeprecatedAssetFile.status_by_id()	This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled. Signature suspend fun status(assetFileId: String): AssetDetails Parameters `assetFileId: String` Returns `AssetDetails` The details on a single asset.
statusById ( assetFileId )	Returns the details AssetDetails on a single asset: ID, file name, and whether it's currently installed This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled. Signature suspend fun statusById(assetFileId: String): AssetDetails Parameters `assetFileId: String` Returns `AssetDetails` The details on a single asset.
statusByName ( assetFileName )	Returns the details AssetDetails on a single asset: ID, file name, and whether it's currently installed This method can return the following status codes: common status codes in AssetFileStatusCode, AssetFileStatusCode.InvalidRequestFormat, AssetFileStatusCode.NotEntitled. Signature suspend fun statusByName(assetFileName: String): AssetDetails Parameters `assetFileName: String` Returns `AssetDetails` The details on a single asset.

AssetFile Class

Signature

Constructors

Methods