API reference

AssetFile Class

The Asset File API provides methods for managing asset files in a virtual environment. The methods include getting details and status com.meta.horizon.platform.ovr.models.AssetDetails#getDownloadStatus(), downloading by ID or name, canceling downloads, and deleting files by ID or name.

Static Methods

delete ( assetFileID )
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDeleteResult> com.meta.horizon.platform.ovr.requests.AssetFile.delete(long assetFileID)
Parameters
assetFileID: long  - The uuid of the asset file.
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.
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDeleteResult> com.meta.horizon.platform.ovr.requests.AssetFile.deleteById(long assetFileID)
Parameters
assetFileID: long  - The asset file ID
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.
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDeleteResult> com.meta.horizon.platform.ovr.requests.AssetFile.deleteByName(String assetFileName)
Parameters
assetFileName: String  - The asset file name
download ( assetFileID )
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDownloadResult> com.meta.horizon.platform.ovr.requests.AssetFile.download(long assetFileID)
Parameters
assetFileID: long  - The uuid of the file.
downloadById ( assetFileID )
Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic com.meta.horizon.platform.ovr.Message.MessageType#Notification_AssetFile_DownloadUpdate to track the downloads.
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDownloadResult> com.meta.horizon.platform.ovr.requests.AssetFile.downloadById(long assetFileID)
Parameters
assetFileID: long  - The asset file ID
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.
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDownloadResult> com.meta.horizon.platform.ovr.requests.AssetFile.downloadByName(String assetFileName)
Parameters
assetFileName: String  - The asset file name
downloadCancel ( assetFileID )
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDownloadCancelResult> com.meta.horizon.platform.ovr.requests.AssetFile.downloadCancel(long assetFileID)
Parameters
assetFileID: long  - The uuid of the asset file.
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.
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDownloadCancelResult> com.meta.horizon.platform.ovr.requests.AssetFile.downloadCancelById(long assetFileID)
Parameters
assetFileID: long  - The asset file ID
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.
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetFileDownloadCancelResult> com.meta.horizon.platform.ovr.requests.AssetFile.downloadCancelByName(String assetFileName)
Parameters
assetFileName: String  - The asset file name
getList ()
Returns an array of asset details with asset file names and their associated IDs com.meta.horizon.platform.ovr.models.AssetDetails#getAssetId(), and whether it's currently installed com.meta.horizon.platform.ovr.models.AssetDetails#getDownloadStatus().
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetDetailsArray> com.meta.horizon.platform.ovr.requests.AssetFile.getList()
setDownloadUpdateNotificationCallbacks ( onSuccess , onError )
Sent to indicate download progress for asset files.
Signature
static void com.meta.horizon.platform.ovr.requests.AssetFile.setDownloadUpdateNotificationCallbacks(Request.Handler< AssetFileDownloadUpdate > onSuccess, Request.Handler< Error > onError)
Parameters
onSuccess: Request.Handler< AssetFileDownloadUpdate >
onError: Request.Handler< Error >
Returns
void
status ( assetFileID )
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetDetails> com.meta.horizon.platform.ovr.requests.AssetFile.status(long assetFileID)
Parameters
assetFileID: long  - The uuid of the asset file.
statusById ( assetFileID )
Returns the details com.meta.horizon.platform.ovr.models.AssetDetails on a single asset: ID, file name, and whether it's currently installed
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetDetails> com.meta.horizon.platform.ovr.requests.AssetFile.statusById(long assetFileID)
Parameters
assetFileID: long  - The asset file ID
statusByName ( assetFileName )
Returns the details com.meta.horizon.platform.ovr.models.AssetDetails on a single asset: ID, file name, and whether it's currently installed
Signature
static Request<com.meta.horizon.platform.ovr.models.AssetDetails> com.meta.horizon.platform.ovr.requests.AssetFile.statusByName(String assetFileName)
Parameters
assetFileName: String  - The asset file name