1. Epic GamesDeveloper
  3. IOnlineUserCloud

IOnlineUserCloud

Provides access to per user cloud file storage

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

References

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

Syntax

class IOnlineUserCloud

Remarks

Provides access to per user cloud file storage

Variables

  Type Name Description
Public variable FOnDeleteUserFileComplete OnDeleteUserFileCompleteDelegates Delegate fired when a user file delete from the network platform's storage is complete
Public variable FOnEnumerateUserFilesComplete OnEnumerateUserFilesCompleteDelegates Delegate fired when the list of files has been returned from the network store
Public variable FOnReadUserFileComplete OnReadUserFileCompleteDelegates Delegate fired when a user file read from the network platform's storage is complete
Public variable FOnRequestUsageInfoComplete OnRequestUsageInfoCompleteDelegates Delegate fired when getting usage statistics from the network platform's storage is complete
Public variable FOnUserCloudAnalyticsEvent OnUserCloudAnalyticsEventDelegates Delegate fired when we would like to report an event to an analytics provider.
Public variable FOnWriteUserFileCanceled OnWriteUserFileCanceledDelegates Delegate fired when a user file write to the network platform's storage is canceled
Public variable FOnWriteUserFileComplete OnWriteUserFileCompleteDelegates Delegate fired when a user file write to the network platform's storage is complete
Public variable FOnWriteUserFileProgress OnWriteUserFileProgressDelegates Delegate fired at intervals during a user file write to the network platform's storage

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 Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function void

CancelWriteUserFile ( const FUniqueNetId& UserId,
const FString& FileName
)

 Cancel the ongoing upload of the specified file, if it is in progress
Public function bool

ClearFile ( const FUniqueNetId& UserId,
const FString& FileName
)

 Empties the cached data for this file if it is not being downloaded currently
Public function bool

ClearFiles ( const FUniqueNetId& UserId
)

 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 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 bool

DeleteUserFile ( const FUniqueNetId& UserId,
const FString& FileName,
bool bShouldCloudDelete,
bool bShouldLocallyDelete
)

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

DumpCloudFileState ( const FUniqueNetId& UserId,
const FString& FileName
)

 Print out the state of a file in the cloud for this service
Public function void

DumpCloudState ( const FUniqueNetId& UserId
)

 Print out the state of the cloud for this service
Public function void

EnumerateUserFiles ( const FUniqueNetId& UserId
)

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

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

 Copies the file data into the specified buffer for the specified file
Public function void

GetUserFileList ( const FUniqueNetId& UserId,
TArray< FCloudFileHeader >& UserFiles
)

 Returns the list of User files that was returned by the network store
Public function bool

ReadUserFile ( const FUniqueNetId& UserId,
const FString& FileName
)

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

RequestUsageInfo ( const FUniqueNetId& UserId
)

 Starts an asynchronous request to get the usage statistics from the cloud storage service
Public function Virtual void

TriggerOnDeleteUserFileCompleteDelegates ( bool Param1,
const FUniqueNetId& Param2,
const FString& Param3
)

  
Public function Virtual void  
Public function Virtual void

TriggerOnReadUserFileCompleteDelegates ( bool Param1,
const FUniqueNetId& Param2,
const FString& Param3
)

  
Public function Virtual void

TriggerOnRequestUsageInfoCompleteDelegates ( bool Param1,
const FUniqueNetId& Param2,
int64 Param3,
const TOptional< int64 >& Param4
)

  
Public function Virtual void  
Public function Virtual void

TriggerOnWriteUserFileCanceledDelegates ( bool Param1,
const FUniqueNetId& Param2,
const FString& Param3
)

  
Public function Virtual void

TriggerOnWriteUserFileCompleteDelegates ( bool Param1,
const FUniqueNetId& Param2,
const FString& Param3
)

  
Public function Virtual void

TriggerOnWriteUserFileProgressDelegates ( int32 Param1,
const FUniqueNetId& Param2,
const FString& Param3
)

  
Public function bool

WriteUserFile ( const FUniqueNetId& UserId,
const FString& FileName,
TArray< uint8 >& FileContents,
bool bCompressBeforeUpload
)

 Starts an asynchronous write of the specified user file to the network platform's file store

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page