Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineUserCloud

Light Theme

Dark Theme

IOnlineUserCloud

Provides access to per user cloud file storage

Windows

MacOS

Linux

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

	Name	Description
FOnDeleteUserFi...	OnDeleteUserFileCompleteDelegates	Delegate fired when a user file delete from the network platform's storage is complete
FOnEnumerateUse...	OnEnumerateUserFilesCompleteDelegates	Delegate fired when the list of files has been returned from the network store
FOnReadUserFile...	OnReadUserFileCompleteDelegates	Delegate fired when a user file read from the network platform's storage is complete
FOnRequestUsage...	OnRequestUsageInfoCompleteDelegates	Delegate fired when getting usage statistics from the network platform's storage is complete
FOnWriteUserFil...	OnWriteUserFileCanceledDelegates	Delegate fired when a user file write to the network platform's storage is canceled
FOnWriteUserFil...	OnWriteUserFileCompleteDelegates	Delegate fired when a user file write to the network platform's storage is complete
FOnWriteUserFil...	OnWriteUserFileProgressDelegates	Delegate fired at intervals during a user file write to the network platform's storage

Constructors

	Name	Description
	IOnlineUserCloud()

Destructors

	Name	Description
	~IOnlineUserCloud()

Functions

	Name	Description
FDelegateHan...	AddOnDeleteUserFileCompleteDelegate_Handle ( const FOnDeleteUserFileCompleteDele... )
FDelegateHan...	AddOnEnumerateUserFilesCompleteDelegate_Handle ( const FOnEnumerateUserFilesComplete... )
FDelegateHan...	AddOnReadUserFileCompleteDelegate_Handle ( const FOnReadUserFileCompleteDelega... )
FDelegateHan...	AddOnRequestUsageInfoCompleteDelegate_Handle ( const FOnRequestUsageInfoCompleteDe... )
FDelegateHan...	AddOnWriteUserFileCanceledDelegate_Handle ( const FOnWriteUserFileCanceledDeleg... )
FDelegateHan...	AddOnWriteUserFileCompleteDelegate_Handle ( const FOnWriteUserFileCompleteDeleg... )
FDelegateHan...	AddOnWriteUserFileProgressDelegate_Handle ( const FOnWriteUserFileProgressDeleg... )
void	CancelWriteUserFile ( const FUniqueNetId& UserId, const FString& FileName )	Cancel the ongoing upload of the specified file, if it is in progress
bool	ClearFile ( const FUniqueNetId& UserId, const FString& FileName )	Empties the cached data for this file if it is not being downloaded currently
bool	ClearFiles ( const FUniqueNetId& UserId )	Empties the set of downloaded files if possible (no async tasks outstanding)
void	ClearOnDeleteUserFileCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnDeleteUserFileCompleteDelegates ( void* Object )
void	ClearOnEnumerateUserFilesCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnEnumerateUserFilesCompleteDelegates ( void* Object )
void	ClearOnReadUserFileCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnReadUserFileCompleteDelegates ( void* Object )
void	ClearOnRequestUsageInfoCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnRequestUsageInfoCompleteDelegates ( void* Object )
void	ClearOnWriteUserFileCanceledDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnWriteUserFileCanceledDelegates ( void* Object )
void	ClearOnWriteUserFileCompleteDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnWriteUserFileCompleteDelegates ( void* Object )
void	ClearOnWriteUserFileProgressDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnWriteUserFileProgressDelegates ( void* Object )
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
void	DumpCloudFileState ( const FUniqueNetId& UserId, const FString& FileName )	Print out the state of a file in the cloud for this service
void	DumpCloudState ( const FUniqueNetId& UserId )	Print out the state of the cloud for this service
void	EnumerateUserFiles ( const FUniqueNetId& UserId )	Requests a list of available User files from the network store
bool	GetFileContents ( const FUniqueNetId& UserId, const FString& FileName, TArray< uint8 >& FileContents )	Copies the file data into the specified buffer for the specified file
void	GetUserFileList ( const FUniqueNetId& UserId, TArray< FCloudFileHeader >& UserFi... )	Returns the list of User files that was returned by the network store
bool	ReadUserFile ( const FUniqueNetId& UserId, const FString& FileName )	Starts an asynchronous read of the specified user file from the network platform's file store
bool	RequestUsageInfo ( const FUniqueNetId& UserId )	Starts an asynchronous request to get the usage statistics from the cloud storage service
void	TriggerOnDeleteUserFileCompleteDelegates ( bool Param1, const FUniqueNetId& Param2, const FString& Param3 )
void	TriggerOnEnumerateUserFilesCompleteDelegates ( bool Param1, const FUniqueNetId& Param2 )
void	TriggerOnReadUserFileCompleteDelegates ( bool Param1, const FUniqueNetId& Param2, const FString& Param3 )
void	TriggerOnRequestUsageInfoCompleteDelegates ( bool Param1, const FUniqueNetId& Param2, int64 Param3, const TOptional< int64 >& Param4 )
void	TriggerOnWriteUserFileCanceledDelegates ( bool Param1, const FUniqueNetId& Param2, const FString& Param3 )
void	TriggerOnWriteUserFileCompleteDelegates ( bool Param1, const FUniqueNetId& Param2, const FString& Param3 )
void	TriggerOnWriteUserFileProgressDelegates ( int32 Param1, const FUniqueNetId& Param2, const FString& Param3 )
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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss