API reference

AssetFileDownloadUpdate Interface

An AssetFileDownloadUpdate represents the download status of an update for an asset file. It contains the asset file ID, the download progress of the update, and its completion status. It can be retrieved using AssetFile.downloadUpdate. AssetFileDownloadUpdate.completed is true means downloaded but probably not installed yet. Call AssetFile.statusById until AssetDetails.downloadStatus changes from 'available' to 'installed'.

Signature

interface AssetFileDownloadUpdate

Properties

assetFileId : String
[Get]
DeprecatedAssetFileDownloadUpdate.asset_id
The API has been deprecated. Please use AssetFileDownloadUpdate.asset_id instead.
Signature
abstract val assetFileId: String
assetId : String
[Get]
ID of the asset file. It can be retrieved using AssetDetails.assetId.
Signature
abstract val assetId: String
bytesTotal : ULong
[Get]
This field is of type uint and represents the total number of bytes in the asset file.
Signature
abstract val bytesTotal: ULong
bytesTransferred : Long
[Get]
An integer represents the number of bytes that have been downloaded. -1 If the download hasn't started yet.
Signature
abstract val bytesTransferred: Long
completed : Boolean
[Get]
This field is of type boolean and indicates whether the asset installation has been completed or not.
Signature
abstract val completed: Boolean