Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Provides access to per user cloud file storage
| Name | IOnlineUserCloud |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineUserCloudInterface.h |
| Include Path | #include "Interfaces/OnlineUserCloudInterface.h" |
Syntax
class IOnlineUserCloud
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IOnlineUserCloud() |
Interfaces/OnlineUserCloudInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOnlineUserCloud() |
Interfaces/OnlineUserCloudInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnDeleteUserFileCompleteDelegates | FOnDeleteUserFileComplete | Delegate fired when a user file delete from the network platform's storage is complete | Interfaces/OnlineUserCloudInterface.h | |
| OnEnumerateUserFilesCompleteDelegates | FOnEnumerateUserFilesComplete | Delegate fired when the list of files has been returned from the network store | Interfaces/OnlineUserCloudInterface.h | |
| OnReadUserFileCompleteDelegates | FOnReadUserFileComplete | Delegate fired when a user file read from the network platform's storage is complete | Interfaces/OnlineUserCloudInterface.h | |
| OnRequestUsageInfoCompleteDelegates | FOnRequestUsageInfoComplete | Delegate fired when getting usage statistics from the network platform's storage is complete | Interfaces/OnlineUserCloudInterface.h | |
| OnUserCloudAnalyticsEventDelegates | FOnUserCloudAnalyticsEvent | Delegate fired when we would like to report an event to an analytics provider. | Interfaces/OnlineUserCloudInterface.h | |
| OnWriteUserFileCanceledDelegates | FOnWriteUserFileCanceled | Delegate fired when a user file write to the network platform's storage is canceled | Interfaces/OnlineUserCloudInterface.h | |
| OnWriteUserFileCompleteDelegates | FOnWriteUserFileComplete | Delegate fired when a user file write to the network platform's storage is complete | Interfaces/OnlineUserCloudInterface.h | |
| OnWriteUserFileProgress64Delegates | FOnWriteUserFileProgress64 | Delegate fired at intervals during a user file write to the network platform's storage | Interfaces/OnlineUserCloudInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddOnDeleteUserFileCompleteDelegate_Handle
(
const FOnDeleteUserFileCompleteDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnEnumerateUserFilesCompleteDelegate_Handle
(
const FOnEnumerateUserFilesCompleteDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnReadUserFileCompleteDelegate_Handle
(
const FOnReadUserFileCompleteDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnRequestUsageInfoCompleteDelegate_Handle
(
const FOnRequestUsageInfoCompleteDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnUserCloudAnalyticsEventDelegate_Handle
(
const FOnUserCloudAnalyticsEventDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnWriteUserFileCanceledDelegate_Handle
(
const FOnWriteUserFileCanceledDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnWriteUserFileCompleteDelegate_Handle
(
const FOnWriteUserFileCompleteDelegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
virtual FDelegateHandle AddOnWriteUserFileProgress64Delegate_Handle
(
const FOnWriteUserFileProgress64Delegate& Delegate |
Interfaces/OnlineUserCloudInterface.h | ||
void CancelWriteUserFile
(
const FUniqueNetId& UserId, |
Cancel the ongoing upload of the specified file, if it is in progress | Interfaces/OnlineUserCloudInterface.h | |
bool ClearFile
(
const FUniqueNetId& UserId, |
Empties the cached data for this file if it is not being downloaded currently | Interfaces/OnlineUserCloudInterface.h | |
bool ClearFiles
(
const FUniqueNetId& UserId |
Empties the set of downloaded files if possible (no async tasks outstanding) | Interfaces/OnlineUserCloudInterface.h | |
virtual void ClearOnDeleteUserFileCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnDeleteUserFileCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnEnumerateUserFilesCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnEnumerateUserFilesCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnReadUserFileCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnReadUserFileCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnRequestUsageInfoCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnRequestUsageInfoCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnUserCloudAnalyticsEventDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnUserCloudAnalyticsEventDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnWriteUserFileCanceledDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnWriteUserFileCanceledDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnWriteUserFileCompleteDelegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnWriteUserFileCompleteDelegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnWriteUserFileProgress64Delegate_Handle
(
FDelegateHandle& Handle |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void ClearOnWriteUserFileProgress64Delegates
(
FDelegateUserObject Object |
Interfaces/OnlineUserCloudInterface.h | ||
bool DeleteUserFile
(
const FUniqueNetId& UserId, |
Starts an asynchronous delete of the specified user file from the network platform's file store | Interfaces/OnlineUserCloudInterface.h | |
void DumpCloudFileState
(
const FUniqueNetId& UserId, |
Print out the state of a file in the cloud for this service | Interfaces/OnlineUserCloudInterface.h | |
void DumpCloudState
(
const FUniqueNetId& UserId |
Print out the state of the cloud for this service | Interfaces/OnlineUserCloudInterface.h | |
void EnumerateUserFiles
(
const FUniqueNetId& UserId |
Requests a list of available User files from the network store | Interfaces/OnlineUserCloudInterface.h | |
bool GetFileContents
(
const FUniqueNetId& UserId, |
Copies the file data into the specified buffer for the specified file | Interfaces/OnlineUserCloudInterface.h | |
void GetUserFileList
(
const FUniqueNetId& UserId, |
Returns the list of User files that was returned by the network store | Interfaces/OnlineUserCloudInterface.h | |
bool ReadUserFile
(
const FUniqueNetId& UserId, |
Starts an asynchronous read of the specified user file from the network platform's file store | Interfaces/OnlineUserCloudInterface.h | |
bool RequestUsageInfo
(
const FUniqueNetId& UserId |
Starts an asynchronous request to get the usage statistics from the cloud storage service | Interfaces/OnlineUserCloudInterface.h | |
virtual void TriggerOnDeleteUserFileCompleteDelegates
(
bool Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void TriggerOnEnumerateUserFilesCompleteDelegates
(
bool Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void TriggerOnReadUserFileCompleteDelegates
(
bool Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void TriggerOnRequestUsageInfoCompleteDelegates
(
bool Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
| Interfaces/OnlineUserCloudInterface.h | |||
virtual void TriggerOnWriteUserFileCanceledDelegates
(
bool Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void TriggerOnWriteUserFileCompleteDelegates
(
bool Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
virtual void TriggerOnWriteUserFileProgress64Delegates
(
uint64 Param1, |
Interfaces/OnlineUserCloudInterface.h | ||
bool WriteUserFile
(
const FUniqueNetId& UserId, |
Starts an asynchronous write of the specified user file to the network platform's file store | Interfaces/OnlineUserCloudInterface.h |