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

#include <InstallBundleManagerReporting.h>

+ Inheritance diagram for FInstallManagerBundleReport:

Public Types

enum class  ECombinedStatus {
  Unknown , Updatable , Updating , Finishing ,
  Finished
}
 

Public Member Functions

BEGIN_JSON_SERIALIZER JSON_SERIALIZE_NAME ("ContextName", ContextName)
 
 JSON_SERIALIZE ("SessionId", SessionId)
 
 JSON_SERIALIZE_OPTIONAL ("BackgroundedCount", BackgroundedCount)
 
 JSON_SERIALIZE ("LoadedCount", LoadedCount)
 
 JSON_SERIALIZE_ARRAY_SERIALIZABLE ("SourceReports", SourceReports, FInstallBundleSourceReport)
 
END_JSON_SERIALIZER INSTALLBUNDLEMANAGER_API FInstallBundleSourceReportTryFindBundleSourceReport (const FInstallBundleSourceType &Type)
 
INSTALLBUNDLEMANAGER_API FInstallBundleSourceReportFindOrAddBundleSourceReport (const FInstallBundleSourceType &Type)
 
INSTALLBUNDLEMANAGER_API float GetDownloadProgress () const
 
INSTALLBUNDLEMANAGER_API float GetInstallationProgress () const
 
INSTALLBUNDLEMANAGER_API uint64 TotalDownloadSize () const
 
INSTALLBUNDLEMANAGER_API uint64 DownloadedBytes () const
 
INSTALLBUNDLEMANAGER_API int TotalBundleCount () const
 
INSTALLBUNDLEMANAGER_API int UpdatedBundleCount () const
 
INSTALLBUNDLEMANAGER_API FString GetProgressString () const
 
INSTALLBUNDLEMANAGER_API FString GetLongProgressString () const
 
INSTALLBUNDLEMANAGER_API ECombinedStatus GetCombinedStatus () const
 
INSTALLBUNDLEMANAGER_API TOptional< FString > GetLowestCurrentBundleVersion () const
 
INSTALLBUNDLEMANAGER_API TOptional< FString > GetHighestCurrentBundleVersion () 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 ContextName
 
FString SessionId
 
TOptional< uint32BackgroundedCount
 
uint32 LoadedCount = 0
 
TArray< FInstallBundleSourceReportSourceReports
 

Member Enumeration Documentation

◆ ECombinedStatus

Enumerator
Unknown 
Updatable 
Updating 
Finishing 
Finished 

Member Function Documentation

◆ DownloadedBytes()

uint64 FInstallManagerBundleReport::DownloadedBytes ( ) const

◆ FindOrAddBundleSourceReport()

FInstallBundleSourceReport & FInstallManagerBundleReport::FindOrAddBundleSourceReport ( const FInstallBundleSourceType Type)

◆ GetCombinedStatus()

FInstallManagerBundleReport::ECombinedStatus FInstallManagerBundleReport::GetCombinedStatus ( ) const

◆ GetDownloadProgress()

float FInstallManagerBundleReport::GetDownloadProgress ( ) const

◆ GetHighestCurrentBundleVersion()

TOptional< FString > FInstallManagerBundleReport::GetHighestCurrentBundleVersion ( ) const

◆ GetInstallationProgress()

float FInstallManagerBundleReport::GetInstallationProgress ( ) const

◆ GetLongProgressString()

FString FInstallManagerBundleReport::GetLongProgressString ( ) const

◆ GetLowestCurrentBundleVersion()

TOptional< FString > FInstallManagerBundleReport::GetLowestCurrentBundleVersion ( ) const

◆ GetProgressString()

FString FInstallManagerBundleReport::GetProgressString ( ) const

◆ JSON_SERIALIZE() [1/2]

FInstallManagerBundleReport::JSON_SERIALIZE ( "LoadedCount"  ,
LoadedCount   
)

◆ JSON_SERIALIZE() [2/2]

FInstallManagerBundleReport::JSON_SERIALIZE ( "SessionId"  ,
SessionId   
)

◆ JSON_SERIALIZE_ARRAY_SERIALIZABLE()

FInstallManagerBundleReport::JSON_SERIALIZE_ARRAY_SERIALIZABLE ( "SourceReports"  ,
SourceReports  ,
FInstallBundleSourceReport   
)

◆ JSON_SERIALIZE_NAME()

BEGIN_JSON_SERIALIZER FInstallManagerBundleReport::JSON_SERIALIZE_NAME ( "ContextName"  ,
ContextName   
)

◆ JSON_SERIALIZE_OPTIONAL()

FInstallManagerBundleReport::JSON_SERIALIZE_OPTIONAL ( "BackgroundedCount"  ,
BackgroundedCount   
)

◆ TotalBundleCount()

int FInstallManagerBundleReport::TotalBundleCount ( ) const

◆ TotalDownloadSize()

uint64 FInstallManagerBundleReport::TotalDownloadSize ( ) const

◆ TryFindBundleSourceReport()

FInstallBundleSourceReport * FInstallManagerBundleReport::TryFindBundleSourceReport ( const FInstallBundleSourceType Type)

◆ UpdatedBundleCount()

int FInstallManagerBundleReport::UpdatedBundleCount ( ) const

Member Data Documentation

◆ BackgroundedCount

TOptional<uint32> FInstallManagerBundleReport::BackgroundedCount

◆ ContextName

FName FInstallManagerBundleReport::ContextName

◆ LoadedCount

uint32 FInstallManagerBundleReport::LoadedCount = 0

◆ SessionId

FString FInstallManagerBundleReport::SessionId

◆ SourceReports

TArray<FInstallBundleSourceReport> FInstallManagerBundleReport::SourceReports

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