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.

Static Member Functions

static Request< Models.AssetFileDeleteResult > Delete

( UInt64 assetFileID )

Parameters

assetFileID

The uuid of the asset file.

Deprecated

Use AssetFile.DeleteById()

static Request< Models.AssetFileDeleteResult > DeleteById

( UInt64 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.

Parameters

assetFileID

The asset file ID

static Request< Models.AssetFileDeleteResult > DeleteByName

( string 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.

Parameters

assetFileName

The asset file name

static Request< Models.AssetFileDownloadResult > Download

( UInt64 assetFileID )

Parameters

assetFileID

The uuid of the file.

Deprecated

Use AssetFile.DownloadById()

static Request< Models.AssetFileDownloadResult > DownloadById

( UInt64 assetFileID )

Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic Message::MessageType::Notification_AssetFile_DownloadUpdate to track the downloads.

Parameters

assetFileID

The asset file ID

static Request< Models.AssetFileDownloadResult > DownloadByName

( string 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.

Parameters

assetFileName

The asset file name

static Request< Models.AssetFileDownloadCancelResult > DownloadCancel

( UInt64 assetFileID )

Parameters

assetFileID

The uuid of the asset file.

Deprecated

Use AssetFile.DownloadCancelById()

static Request< Models.AssetFileDownloadCancelResult > DownloadCancelById

( UInt64 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.

Parameters

assetFileID

The asset file ID

static Request< Models.AssetFileDownloadCancelResult > DownloadCancelByName

( string 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.

Parameters

assetFileName

The asset file name

static Request< Models.AssetDetailsList > 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.

static Request< Models.AssetDetails > Status

( UInt64 assetFileID )

Parameters

assetFileID

The uuid of the asset file.

Deprecated

Use AssetFile.StatusById()

static Request< Models.AssetDetails > StatusById

( UInt64 assetFileID )

Returns the details Models.AssetDetails on a single asset: ID, file name, and whether it's currently installed

Parameters

assetFileID