1. Epic GamesDeveloper
  3. IOnlineTitleFile

IOnlineTitleFile

API > API/Plugins > API/Plugins/OnlineSubsystem

   
Name IOnlineTitleFile
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTitleFileInterface.h
Include Path #include "Interfaces/OnlineTitleFileInterface.h"

Syntax

class IOnlineTitleFile

Constructors

Name Remarks Include Path Unreal Specifiers

IOnlineTitleFile()

   Interfaces/OnlineTitleFileInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineTitleFile()

   Interfaces/OnlineTitleFileInterface.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnEnumerateFilesCompleteDelegates FOnEnumerateFilesComplete Delegate fired when the list of files has been returned from the network store Interfaces/OnlineTitleFileInterface.h  
OnReadFileCompleteDelegates FOnReadFileComplete Delegate fired when a file read from the network platform's storage is complete Interfaces/OnlineTitleFileInterface.h  
OnReadFileProgressDelegates FOnReadFileProgress Delegate fired when as file read from the network platform's storage progresses Interfaces/OnlineTitleFileInterface.h  
OnTitleFileAnalyticsEventDelegates FOnTitleFileAnalyticsEvent Delegate fired when we would like to report an event to an analytics provider. Interfaces/OnlineTitleFileInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FDelegateHandle AddOnEnumerateFilesCompleteDelegate_Handle ( const FOnEnumerateFilesCompleteDelegate& Delegate
)

   Interfaces/OnlineTitleFileInterface.h  

virtual FDelegateHandle AddOnReadFileCompleteDelegate_Handle ( const FOnReadFileCompleteDelegate& Delegate
)

   Interfaces/OnlineTitleFileInterface.h  

virtual FDelegateHandle AddOnReadFileProgressDelegate_Handle ( const FOnReadFileProgressDelegate& Delegate
)

   Interfaces/OnlineTitleFileInterface.h  

virtual FDelegateHandle AddOnTitleFileAnalyticsEventDelegate_Handle ( const FOnTitleFileAnalyticsEventDelegate& Delegate
)

   Interfaces/OnlineTitleFileInterface.h  

bool ClearFile ( const FString& FileName
)

 Empties the cached data for this file if it is not being downloaded currently Interfaces/OnlineTitleFileInterface.h  

bool ClearFiles()

 Empties the set of downloaded files if possible (no async tasks outstanding) Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnEnumerateFilesCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnEnumerateFilesCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnReadFileCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnReadFileCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnReadFileProgressDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnReadFileProgressDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnTitleFileAnalyticsEventDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void ClearOnTitleFileAnalyticsEventDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineTitleFileInterface.h  

void DeleteCachedFiles ( bool bSkipEnumerated
)

 Delete cached files on disk Interfaces/OnlineTitleFileInterface.h  

bool EnumerateFiles ( const FPagedQuery& Page
)

 Requests a list of available files from the network store Interfaces/OnlineTitleFileInterface.h  

bool GetFileContents ( const FString& FileName,
TArray< uint8 >& FileContents
)

 Copies the file data into the specified buffer for the specified file Interfaces/OnlineTitleFileInterface.h  

void GetFileList ( TArray< FCloudFileHeader >& Files
)

 Returns the list of files that was returned by the network store Interfaces/OnlineTitleFileInterface.h  

bool ReadFile ( const FString& FileName
)

 Starts an asynchronous read of the specified file from the network platform's file store Interfaces/OnlineTitleFileInterface.h  

virtual void TriggerOnEnumerateFilesCompleteDelegates ( bool Param1,
const FString& Param2
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void TriggerOnReadFileCompleteDelegates ( bool Param1,
const FString& Param2
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void TriggerOnReadFileProgressDelegates ( const FString& Param1,
uint64 Param2
)

   Interfaces/OnlineTitleFileInterface.h  

virtual void TriggerOnTitleFileAnalyticsEventDelegates ( const FString& Param1,
const TArray< FAnalyticsEventAttribute >& Param2
)

   Interfaces/OnlineTitleFileInterface.h  

Protected

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page