CloudStorageBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Engine/PlatformInterfaceBase.h"
#include "CloudStorageBase.generated.h"
 
UENUM()
enum ECloudStorageDelegate : int
{
    // @todo: Fill in the result descriptions for these (and the other PI subclasses)
    CSD_KeyValueReadComplete,
    CSD_KeyValueWriteComplete,
    CSD_ValueChanged,
    CSD_DocumentQueryComplete,
    CSD_DocumentReadComplete,
    CSD_DocumentWriteComplete,
    // Data: Document index that has the conflict
    // Type: Int
    CSD_DocumentConflictDetected,
    CSD_MAX,
};
 
 
UCLASS()
class UCloudStorageBase
    : public UPlatformInterfaceBase
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    TArray<FString> LocalCloudFiles;
 
    UPROPERTY()
    uint32 bSuppressDelegateCalls:1;
 
    virtual void Init();
 
    virtual bool ReadKeyValue(const FString& KeyName, EPlatformInterfaceDataType Type, class UObject* SerializedObj = nullptr);
 
    virtual bool WriteKeyValue(const FString& KeyName, const FPlatformInterfaceData& Value);
 
    virtual bool QueryForCloudDocuments();
 
    virtual int32 GetNumCloudDocuments(bool bIsForConflict = false);
 
    virtual FString GetCloudDocumentName(int32 Index);
 
    virtual int32 CreateCloudDocument(const FString& Filename);
 
    virtual bool ReadCloudDocument(int32 Index, bool bIsForConflict = false);
 
    virtual FString ParseDocumentAsString(int32 Index, bool bIsForConflict = false);
 
    virtual void ParseDocumentAsBytes(int32 Index, TArray<uint8>& ByteData, bool bIsForConflict = false);
 
    virtual class UObject* ParseDocumentAsObject(int32 Index, TSubclassOf<class UObject> ObjectClass, int32 ExpectedVersion, bool bIsForConflict = false);
 
    virtual bool WriteCloudDocument(int32 Index);
 
    virtual bool SaveDocumentWithString(int32 Index, const FString& StringData);
 
    virtual bool SaveDocumentWithBytes(int32 Index, const TArray<uint8>& ByteData);
 
    virtual bool SaveDocumentWithObject(int32 Index, class UObject* ObjectData, int32 SaveVersion);
 
    virtual bool ResolveConflictWithNewestDocument();
 
    virtual bool ResolveConflictWithVersionIndex(int32 Index);
};