UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FInstallBundleReport Struct Reference

#include <InstallBundleManagerReporting.h>

+ Inheritance diagram for FInstallBundleReport:

Classes

struct  FStateInstalling
 
struct  FStateUpdatable
 
struct  FStateUpdated
 
struct  FStateUpdating
 

Public Types

using FState = TVariant< FStateUpdatable, FStateUpdating, FStateInstalling, FStateUpdated >
 

Public Member Functions

BEGIN_JSON_SERIALIZER JSON_SERIALIZE_NAME ("Name", BundleName)
 
 JSON_SERIALIZE_OPTIONAL ("SourceVersion", SourceVersion)
 
 JSON_SERIALIZE_OPTIONAL_VARIANT_BEGIN ("State", State)
 
 JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ("StateUpdatable", FStateUpdatable)
 
 JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ("StateUpdating", FStateUpdating)
 
 JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ("StateInstalling", FStateInstalling)
 
 JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ("StateUpdated", FStateUpdated)
 
 JSON_SERIALIZE_OPTIONAL_VARIANT_END ()
 
END_JSON_SERIALIZER INSTALLBUNDLEMANAGER_API uint64 TotalDownloadSize () const
 
INSTALLBUNDLEMANAGER_API uint64 DownloadedBytes () const
 
INSTALLBUNDLEMANAGER_API float InstallationProgress () const
 
INSTALLBUNDLEMANAGER_API void AddDiscrepancy (uint64 Bytes)
 
bool IsUnknown () const
 
bool IsUpdatable () const
 
bool IsUpdating () const
 
bool IsInstalling () const
 
bool IsUpdated () const
 
- Public Member Functions inherited from FJsonSerializable
virtual JSON_API ~FJsonSerializable ()
 
JSON_API const FString ToJson (bool bPrettyPrint=true) const
 
JSON_API const FUtf8String ToJsonUtf8 (bool bPrettyPrint=true) const
 
virtual JSON_API const FString ToJson (bool bPrettyPrint=true)
 
virtual JSON_API const FUtf8String ToJsonUtf8 (bool bPrettyPrint=true)
 
template<class CharType , class PrintPolicy , ESPMode SPMode>
void ToJson (TSharedRef< TJsonWriter< CharType, PrintPolicy >, SPMode > JsonWriter, bool bFlatObject=false) const
 
virtual JSON_API bool FromJson (const TCHAR *Json)
 
virtual JSON_API bool FromJson (const UTF8CHAR *Json)
 
virtual JSON_API bool FromJson (const FString &Json)
 
virtual JSON_API bool FromJson (const FUtf8String &Json)
 
virtual JSON_API bool FromJson (FString &&Json)
 
virtual JSON_API bool FromJson (FUtf8String &&Json)
 
JSON_API bool FromJsonStringView (FUtf8StringView JsonStringView)
 
JSON_API bool FromJsonStringView (FWideStringView JsonStringView)
 
virtual JSON_API bool FromJson (TSharedPtr< FJsonObject > JsonObject)
 
virtual void Serialize (FJsonSerializerBase &Serializer, bool bFlatObject)=0
 

Public Attributes

FName BundleName
 
TOptional< FString > SourceVersion
 
TOptional< FStateState
 

Member Typedef Documentation

◆ FState

Member Function Documentation

◆ AddDiscrepancy()

void FInstallBundleReport::AddDiscrepancy ( uint64  Bytes)

◆ DownloadedBytes()

uint64 FInstallBundleReport::DownloadedBytes ( ) const

◆ InstallationProgress()

float FInstallBundleReport::InstallationProgress ( ) const

◆ IsInstalling()

bool FInstallBundleReport::IsInstalling ( ) const
inline

◆ IsUnknown()

bool FInstallBundleReport::IsUnknown ( ) const
inline

◆ IsUpdatable()

bool FInstallBundleReport::IsUpdatable ( ) const
inline

◆ IsUpdated()

bool FInstallBundleReport::IsUpdated ( ) const
inline

◆ IsUpdating()

bool FInstallBundleReport::IsUpdating ( ) const
inline

◆ JSON_SERIALIZE_NAME()

BEGIN_JSON_SERIALIZER FInstallBundleReport::JSON_SERIALIZE_NAME ( "Name"  ,
BundleName   
)

◆ JSON_SERIALIZE_OPTIONAL()

FInstallBundleReport::JSON_SERIALIZE_OPTIONAL ( "SourceVersion"  ,
SourceVersion   
)

◆ JSON_SERIALIZE_OPTIONAL_VARIANT_BEGIN()

FInstallBundleReport::JSON_SERIALIZE_OPTIONAL_VARIANT_BEGIN ( "State"  ,
State   
)

◆ JSON_SERIALIZE_OPTIONAL_VARIANT_END()

FInstallBundleReport::JSON_SERIALIZE_OPTIONAL_VARIANT_END ( )

◆ JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE() [1/4]

FInstallBundleReport::JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ( "StateInstalling"  ,
FStateInstalling   
)

◆ JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE() [2/4]

FInstallBundleReport::JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ( "StateUpdatable"  ,
FStateUpdatable   
)

◆ JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE() [3/4]

FInstallBundleReport::JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ( "StateUpdated"  ,
FStateUpdated   
)

◆ JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE() [4/4]

FInstallBundleReport::JSON_SERIALIZE_VARIANT_IFTYPE_SERIALIZABLE ( "StateUpdating"  ,
FStateUpdating   
)

◆ TotalDownloadSize()

uint64 FInstallBundleReport::TotalDownloadSize ( ) const

Member Data Documentation

◆ BundleName

FName FInstallBundleReport::BundleName

◆ SourceVersion

TOptional<FString> FInstallBundleReport::SourceVersion

◆ State

TOptional<FState> FInstallBundleReport::State

The documentation for this struct was generated from the following files: