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

AssetFile Class

Overview

Static Public Member Functions

Delete
( UInt64 assetFileID )
DeleteById
( UInt64 assetFileID )
DeleteByName
( string assetFileName )
Download
( UInt64 assetFileID )
DownloadById
( UInt64 assetFileID )
DownloadByName
( string assetFileName )
DownloadCancel
( UInt64 assetFileID )
DownloadCancelById
( UInt64 assetFileID )
DownloadCancelByName
( string assetFileName )
GetList ( )
Status
( UInt64 assetFileID )
StatusById
( UInt64 assetFileID )
StatusByName
( string assetFileName )
static void

Details

Static Member Functions

static Request<Models.AssetFileDeleteResult> Oculus.Platform.AssetFile.Delete
( UInt64 assetFileID )
DEPRECATED. Use AssetFile.DeleteById()
static Request<Models.AssetFileDeleteResult> Oculus.Platform.AssetFile.DeleteById
( UInt64 assetFileID )
Removes an 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> Oculus.Platform.AssetFile.DeleteByName
( string assetFileName )
Removes an 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> Oculus.Platform.AssetFile.Download
( UInt64 assetFileID )
DEPRECATED. Use AssetFile.DownloadById()
static Request<Models.AssetFileDownloadResult> Oculus.Platform.AssetFile.DownloadById
( UInt64 assetFileID )
Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic MessageType.Notification_AssetFile_DownloadUpdate to track the downloads.
Parameters
assetFileID
The asset file ID
static Request<Models.AssetFileDownloadResult> Oculus.Platform.AssetFile.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> Oculus.Platform.AssetFile.DownloadCancel
( UInt64 assetFileID )
DEPRECATED. Use AssetFile.DownloadCancelById()
static Request<Models.AssetFileDownloadCancelResult> Oculus.Platform.AssetFile.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> Oculus.Platform.AssetFile.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> Oculus.Platform.AssetFile.GetList ( )
Returns an array of objects with asset file names and their associated IDs, and and whether it's currently installed.
static Request<Models.AssetDetails> Oculus.Platform.AssetFile.Status
( UInt64 assetFileID )
DEPRECATED. Use AssetFile.StatusById()
static Request<Models.AssetDetails> Oculus.Platform.AssetFile.StatusById
( UInt64 assetFileID )
Returns the details on a single asset: ID, file name, and whether it's currently installed
Parameters
assetFileID
The asset file ID
static Request<Models.AssetDetails> Oculus.Platform.AssetFile.StatusByName
( string assetFileName )
Returns the details on a single asset: ID, file name, and whether it's currently installed
Parameters
assetFileName
The asset file name
static void Oculus.Platform.AssetFile.SetDownloadUpdateNotificationCallback
( Message< Models.AssetFileDownloadUpdate >.Callback callback )
Sent to indicate download progress for asset files.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon