1. Epic GamesDeveloper
  3. IOnlineTitleFile

IOnlineTitleFile

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

References

   
Module OnlineSubsystem
Header /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineTitleFileInterface.h
Include #include "Interfaces/OnlineTitleFileInterface.h"

Syntax

class IOnlineTitleFile

Variables

  Type Name Description
Public variable FOnEnumerateFilesComplete OnEnumerateFilesCompleteDelegates Delegate fired when the list of files has been returned from the network store
Public variable FOnReadFileComplete OnReadFileCompleteDelegates Delegate fired when a file read from the network platform's storage is complete
Public variable FOnReadFileProgress OnReadFileProgressDelegates Delegate fired when as file read from the network platform's storage progresses
Public variable FOnTitleFileAnalyticsEvent OnTitleFileAnalyticsEventDelegates Delegate fired when we would like to report an event to an analytics provider.

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function bool

ClearFile ( const FString& FileName
)

 Empties the cached data for this file if it is not being downloaded currently
Public function bool Empties the set of downloaded files if possible (no async tasks outstanding)
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function void

DeleteCachedFiles ( bool bSkipEnumerated
)

 Delete cached files on disk
Public function bool

EnumerateFiles ( const FPagedQuery& Page
)

 Requests a list of available files from the network store
Public function bool

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

 Copies the file data into the specified buffer for the specified file
Public function void Returns the list of files that was returned by the network store
Public function bool

ReadFile ( const FString& FileName
)

 Starts an asynchronous read of the specified file from the network platform's file store
Public function Virtual void

TriggerOnEnumerateFilesCompleteDelegates ( bool Param1,
const FString& Param2
)

  
Public function Virtual void

TriggerOnReadFileCompleteDelegates ( bool Param1,
const FString& Param2
)

  
Public function Virtual void  
Public function Virtual void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page