FPicoAssetFileInterface Class Reference

PicoAssetFileInterface class. More...

#include <Pico_AssetFile.h>

Public Member Functions
bool	DeleteByID (FString AssetFileID, FAssetFileDeleteResult InDeleteByIDDelegate)
	Deletes an installed asset file by asset file ID. The corresponding asset file will be removed from the device. More...
bool	DeleteByName (FString AssetFileName, FAssetFileDeleteResult InDeleteByNameDelegate)
	Deletes an installed asset file by asset file name. The corresponding asset file will be removed from the device. More...
bool	DownloadById (FString AssetFileID, FAssetFileDownloadResult InDownloadByIDDelegate)
	Downloads an asset file by asset file ID. More...
bool	DownloadByName (FString AssetFileName, FAssetFileDownloadResult InDownloadByNameDelegate)
	Downloads an asset file by asset file name. More...
bool	DownloadCancelById (FString AssetFileID, FAssetFileDownloadCancelResult InDownloadCancelByIDDelegate)
	Cancels the download of an asset file by asset file ID. More...
bool	DownloadCancelByName (FString AssetFileName, FAssetFileDownloadCancelResult InDownloadCancelByNameDelegate)
	Cancels the download of an asset file by asset file name. More...
bool	GetAssetFileList (FGetAssetFileList InGetAssetFileListDelegate)
	Gets the asset file list. More...
bool	GetNextAssetDetailsArrayPage (UPico_AssetDetailsArray *InAssetDetailsArray, FGetAssetFileList InGetNextAssetDetailsArrayPageDelegate)
	Gets the next page of the asset file list. More...
bool	GetAssetFileStatusById (FString AssetFileID, FGetAssetFileStatus InGetAssetFileStatusByIdDelegate)
	Gets the download status of an asset file by asset file ID. More...
bool	GetAssetFileStatusByName (FString AssetFileName, FGetAssetFileStatus InGetAssetFileStatusByNameDelegate)
	Gets the download status of an asset file by asset file name. More...

Public Attributes
FAssetFileDownloadUpdateNotify	AssetFileDownloadUpdateCallback
	Sets the callback to track the download progress of asset file. The Transferred field indicates the number of bytes downloaded. The CompleteStatus field indicates the download status.
FAssetFileDeleteForSafetyNotify	AssetFileDeleteForSafetyCallback
	Sets the callback to automatically delete a downloaded asset file if it is different from the original one, and the app will receive a notification.

Detailed Description

PicoAssetFileInterface class.

Member Function Documentation

DeleteByID()

bool DeleteByID	(	FString	AssetFileID,
		FAssetFileDeleteResult	InDeleteByIDDelegate
	)

Deletes an installed asset file by asset file ID. The corresponding asset file will be removed from the device.

Parameters

AssetFileID	The ID of the asset file to delete.
InDeleteByIDDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

DeleteByName()

bool DeleteByName	(	FString	AssetFileName,
		FAssetFileDeleteResult	InDeleteByNameDelegate
	)

Deletes an installed asset file by asset file name. The corresponding asset file will be removed from the device.

Parameters

AssetFileName	The name of the asset file to delete.
InDeleteByNameDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

DownloadById()

bool DownloadById	(	FString	AssetFileID,
		FAssetFileDownloadResult	InDownloadByIDDelegate
	)

Downloads an asset file by asset file ID.

Parameters

AssetFileID	The ID of the asset file to download.
InDownloadByIDDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

DownloadByName()

bool DownloadByName	(	FString	AssetFileName,
		FAssetFileDownloadResult	InDownloadByNameDelegate
	)

Downloads an asset file by asset file name.

Parameters

AssetFileName	The name of the asset file to download.
InDownloadByNameDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

DownloadCancelById()

bool DownloadCancelById	(	FString	AssetFileID,
		FAssetFileDownloadCancelResult	InDownloadCancelByIDDelegate
	)

Cancels the download of an asset file by asset file ID.

Parameters

AssetFileID	The ID of the asset file to cancel download for.
InDownloadCancelByIDDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

DownloadCancelByName()

bool DownloadCancelByName	(	FString	AssetFileName,
		FAssetFileDownloadCancelResult	InDownloadCancelByNameDelegate
	)

Cancels the download of an asset file by asset file name.

Parameters

AssetFileName	The name of the asset file to cancel download for.
InDownloadCancelByNameDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

GetAssetFileList()

bool GetAssetFileList

(

FGetAssetFileList

InGetAssetFileListDelegate

)

Gets the asset file list.

Parameters

InGetAssetFileListDelegate

Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

GetAssetFileStatusById()

bool GetAssetFileStatusById	(	FString	AssetFileID,
		FGetAssetFileStatus	InGetAssetFileStatusByIdDelegate
	)

Gets the download status of an asset file by asset file ID.

Parameters

AssetFileID	The ID of the asset file to get the download status for.
InGetAssetFileStatusByIdDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

GetAssetFileStatusByName()

bool GetAssetFileStatusByName	(	FString	AssetFileName,
		FGetAssetFileStatus	InGetAssetFileStatusByNameDelegate
	)

Gets the download status of an asset file by asset file name.

Parameters

AssetFileName	The name of the asset file to get the download status for.
InGetAssetFileStatusByNameDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure

GetNextAssetDetailsArrayPage()

bool GetNextAssetDetailsArrayPage	(	UPico_AssetDetailsArray *	InAssetDetailsArray,
		FGetAssetFileList	InGetNextAssetDetailsArrayPageDelegate
	)

Gets the next page of the asset file list.

Parameters

InAssetDetailsArray	The current asset details array object.
InGetNextAssetDetailsArrayPageDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class.

Returns

Bool:

• true: success
• false: failure