#include <IBuildManifest.h>

Inheritance diagram for IBuildManifest:

Public Member Functions
virtual	~IBuildManifest ()

virtual uint32	GetAppID () const =0

virtual const FString &	GetAppName () const =0

virtual const FString &	GetVersionString () const =0

virtual const FString &	GetLaunchExe () const =0

virtual const FString &	GetLaunchCommand () const =0

virtual const TSet< FString > &	GetPrereqIds () const =0

virtual const FString &	GetPrereqName () const =0

virtual const FString &	GetPrereqPath () const =0

virtual const FString &	GetPrereqArgs () const =0

virtual int64	GetDownloadSize () const =0

virtual int64	GetDownloadSize (const TSet< FString > &Tags) const =0

virtual int64	GetDeltaDownloadSize (const TSet< FString > &Tags, const IBuildManifestRef &PreviousVersion) const =0

virtual int64	GetDeltaDownloadSize (const TSet< FString > &Tags, const IBuildManifestRef &PreviousVersion, const TSet< FString > &PreviousTags) const =0

virtual int64	GetBuildSize () const =0

virtual int64	GetBuildSize (const TSet< FString > &Tags) const =0

virtual TArray< FString >	GetBuildFileList () const =0

virtual TArray< FStringView >	GetBuildFileListView () const =0

virtual TArray< FString >	GetBuildFileList (const TSet< FString > &Tags) const =0

virtual TArray< FStringView >	GetBuildFileListView (const TSet< FString > &Tags) const =0

virtual int64	GetFileSize (FStringView Filename) const =0

virtual int64	GetFileSize (const TArray< FString > &Filenames) const =0

virtual int64	GetFileSize (const TSet< FString > &Filenames) const =0

virtual bool	GetFileHash (const FString &Filename, FSHAHash &OutHash) const =0

virtual TSet< FString >	GetFileTagList () const =0

virtual void	GetFileTagList (TSet< FString > &Tags) const =0

virtual void	GetOutdatedFiles (const IBuildManifestRef &OldManifest, TSet< FString > &OutdatedFiles) const =0

virtual void	GetRemovableFiles (const IBuildManifestRef &OldManifest, TArray< FString > &RemovableFiles) const =0

virtual void	GetRemovableFiles (const TCHAR *InstallPath, TArray< FString > &RemovableFiles) const =0

virtual bool	NeedsResaving () const =0

virtual void	CopyCustomFields (const IBuildManifestRef &Other, bool bClobber)=0

virtual const IManifestFieldPtr	GetCustomField (const FString &FieldName) const =0

virtual const IManifestFieldPtr	SetCustomField (const FString &FieldName, const FString &Value)=0

virtual const IManifestFieldPtr	SetCustomField (const FString &FieldName, const double &Value)=0

virtual const IManifestFieldPtr	SetCustomField (const FString &FieldName, const int64 &Value)=0

virtual void	RemoveCustomField (const FString &FieldName)=0

virtual IBuildManifestRef	Duplicate () const =0

Detailed Description

Interface to a Build Manifest.

Constructor & Destructor Documentation

◆ ~IBuildManifest()

virtual IBuildManifest::~IBuildManifest ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ CopyCustomFields()

virtual void IBuildManifest::CopyCustomFields	(	const IBuildManifestRef &	Other,
		bool	bClobber
	)

pure virtual

Copy the custom fields from another manifest into this one. If this manifest has custom fields, matching keys will be overwritten but extras will remain

Parameters

Other	The manifest to copy from
bClobber	Whether to overwrite any already existing fields

Implemented in FBuildPatchAppManifest.

◆ Duplicate()

virtual IBuildManifestRef IBuildManifest::Duplicate ( ) const

pure virtual

Duplicated this manifest to create a copy. Should be used if storing a received manifest as an installed manifest which would then be unique

Returns: A shared ref to the new manifest

Implemented in FBuildPatchAppManifest.

◆ GetAppID()

virtual uint32 IBuildManifest::GetAppID ( ) const

pure virtual

Get the App ID that this manifest belongs to

Returns: the app ID

Implemented in FBuildPatchAppManifest.

◆ GetAppName()

virtual const FString & IBuildManifest::GetAppName ( ) const

pure virtual

Get the name of the App that this manifest belongs to

Returns: the app name

Implemented in FBuildPatchAppManifest.

◆ GetBuildFileList() [1/2]

virtual TArray< FString > IBuildManifest::GetBuildFileList ( ) const

pure virtual

Get the list of files in this build. Filenames are all relative to an install directory

Returns: an array containing build files

Implemented in FBuildPatchAppManifest.

◆ GetBuildFileList() [2/2]

virtual TArray< FString > IBuildManifest::GetBuildFileList ( const TSet< FString > & Tags ) const

pure virtual

Get the list of files in this build which match a tag from a given set. Filenames are all relative to an install directory

Parameters

Tags	The set of tags to query

Returns: an array containing build files

Implemented in FBuildPatchAppManifest.

◆ GetBuildFileListView() [1/2]

virtual TArray< FStringView > IBuildManifest::GetBuildFileListView ( ) const

pure virtual

Get the list of files in this build. Filenames are all relative to an install directory. Filenames returned are a view over memory owned by the BuildManifest

Returns: an array containing build files

Implemented in FBuildPatchAppManifest.

◆ GetBuildFileListView() [2/2]

virtual TArray< FStringView > IBuildManifest::GetBuildFileListView ( const TSet< FString > & Tags ) const

pure virtual

Get the list of files in this build which match a tag from a given set. Filenames are all relative to an install directory Filenames returned are a view over memory owned by the BuildManifest

Returns: an array containing build files

Implemented in FBuildPatchAppManifest.

◆ GetBuildSize() [1/2]

virtual int64 IBuildManifest::GetBuildSize ( ) const

pure virtual

Get the size of this build

Returns: the build size in bytes

Implemented in FBuildPatchAppManifest.

◆ GetBuildSize() [2/2]

virtual int64 IBuildManifest::GetBuildSize ( const TSet< FString > & Tags ) const

pure virtual

Get the size of the build of this set of tags

Parameters

Tags	IN A list of the tags we want to know the size of

Returns: the build size of the tags in bytes

Implemented in FBuildPatchAppManifest.

◆ GetCustomField()

virtual const IManifestFieldPtr IBuildManifest::GetCustomField ( const FString & FieldName ) const

pure virtual

Get a custom field from the manifest

Parameters

FieldName The name of the custom field

Returns: An interface to the field

Implemented in FBuildPatchAppManifest.

◆ GetDeltaDownloadSize() [1/2]

virtual int64 IBuildManifest::GetDeltaDownloadSize	(	const TSet< FString > &	Tags,
		const IBuildManifestRef &	PreviousVersion
	)		const

pure virtual

Get the size of the download of this set of tags

Parameters

Tags	IN The tags used for installation, will be applied to both manifests
PreviousVersion	IN The manifest for previous version to compare against

Returns: the minimum download size required in bytes

Implemented in FBuildPatchAppManifest.

◆ GetDeltaDownloadSize() [2/2]

virtual int64 IBuildManifest::GetDeltaDownloadSize	(	const TSet< FString > &	Tags,
		const IBuildManifestRef &	PreviousVersion,
		const TSet< FString > &	PreviousTags
	)		const

pure virtual

Get the size of the download of this set of tags

Parameters

Tags	IN The tags used for installation
PreviousVersion	IN The manifest for previous version to compare against
PreviousTags	IN The tags used for previous installation

Returns: the minimum download size required in bytes

Implemented in FBuildPatchAppManifest.

◆ GetDownloadSize() [1/2]

virtual int64 IBuildManifest::GetDownloadSize ( ) const

pure virtual

Get the size of this download, assuming fresh install

Returns: the total download size in bytes

Implemented in FBuildPatchAppManifest.

◆ GetDownloadSize() [2/2]

virtual int64 IBuildManifest::GetDownloadSize ( const TSet< FString > & Tags ) const

pure virtual

Get the size of the download of this set of tags

Parameters

Tags	IN A list of the tags we want to know the size of

Returns: the download size of the tags in bytes

Implemented in FBuildPatchAppManifest.

◆ GetFileHash()

virtual bool IBuildManifest::GetFileHash	(	const FString &	Filename,
		FSHAHash &	OutHash
	)		const

pure virtual

Gets the file hash for a given file

Parameters

Filename	IN The filename in the build
OutHash	OUT Receives the hash value if found

Returns: true if we had the hash for this file

Implemented in FBuildPatchAppManifest.

◆ GetFileSize() [1/3]

virtual int64 IBuildManifest::GetFileSize ( const TArray< FString > & Filenames ) const

pure virtual

Returns the total size of all files in the array

Parameters

Filenames The array of files.

Returns: the total size of files in array.

Implemented in FBuildPatchAppManifest.

◆ GetFileSize() [2/3]

virtual int64 IBuildManifest::GetFileSize ( const TSet< FString > & Filenames ) const

pure virtual

Returns the total size of all files in the set

Parameters

Filenames The set of files.

Returns: the total size of files in set.

Implemented in FBuildPatchAppManifest.

◆ GetFileSize() [3/3]

virtual int64 IBuildManifest::GetFileSize ( FStringView Filename ) const

pure virtual

Returns the size of a particular file in the build

Parameters

Filename The file.

Returns: the file size.

Implemented in FBuildPatchAppManifest.

◆ GetFileTagList() [1/2]

virtual TSet< FString > IBuildManifest::GetFileTagList ( ) const

pure virtual

Get the list of install tags in this manifest

Returns: the tags referenced.

Implemented in FBuildPatchAppManifest.

◆ GetFileTagList() [2/2]

virtual void IBuildManifest::GetFileTagList ( TSet< FString > & Tags ) const

pure virtual

Get the list of install tags in this manifest

Parameters

Tags	OUT Receives the tags referenced.

Implemented in FBuildPatchAppManifest.

◆ GetLaunchCommand()

virtual const FString & IBuildManifest::GetLaunchCommand ( ) const

pure virtual

Get the command line arguments that the launch exe should be ran with

Returns: the launch command line

Implemented in FBuildPatchAppManifest.

◆ GetLaunchExe()

virtual const FString & IBuildManifest::GetLaunchExe ( ) const

pure virtual

Get the local install path to the exe that launches the App

Returns: local path to the launch exe

Implemented in FBuildPatchAppManifest.

◆ GetOutdatedFiles()

virtual void IBuildManifest::GetOutdatedFiles	(	const IBuildManifestRef &	OldManifest,
		TSet< FString > &	OutdatedFiles
	)		const

pure virtual

Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.

Parameters

OldManifest	IN The Build Manifest that is currently installed.
RemovableFiles	OUT A list to receive the files that may be removed.

Implemented in FBuildPatchAppManifest.

◆ GetPrereqArgs()

virtual const FString & IBuildManifest::GetPrereqArgs ( ) const

pure virtual

Get the command line arguments that should be passed to the prerequisites installer

Returns: the prerequisites installer command line arguments

Implemented in FBuildPatchAppManifest.

◆ GetPrereqIds()

virtual const TSet< FString > & IBuildManifest::GetPrereqIds ( ) const

pure virtual

Get the list of prereq ids that the prereq installer of this manifest satisfies

Returns: the set containing the prereq ids.

Implemented in FBuildPatchAppManifest.

◆ GetPrereqName()

virtual const FString & IBuildManifest::GetPrereqName ( ) const

pure virtual

Get the name of the prerequisites installer for the app

Returns: the prerequisites installer name

Implemented in FBuildPatchAppManifest.

◆ GetPrereqPath()

virtual const FString & IBuildManifest::GetPrereqPath ( ) const

pure virtual

Get the path to the prerequisites installer exe

Returns: local path to the prerequisites installer

Implemented in FBuildPatchAppManifest.

◆ GetRemovableFiles() [1/2]

virtual void IBuildManifest::GetRemovableFiles	(	const IBuildManifestRef &	OldManifest,
		TArray< FString > &	RemovableFiles
	)		const

pure virtual

Gets a list of files that were installed with the Old Manifest, but no longer required by this Manifest.

Parameters

OldManifest	IN The Build Manifest that is currently installed.
RemovableFiles	OUT A list to receive the files that may be removed.

Implemented in FBuildPatchAppManifest.

◆ GetRemovableFiles() [2/2]

virtual void IBuildManifest::GetRemovableFiles	(	const TCHAR *	InstallPath,
		TArray< FString > &	RemovableFiles
	)		const

pure virtual

Gets a list of files that are installed in InstallPath, but no longer required by this Manifest.

Parameters

InstallPath	IN The path to the currently installed files.
RemovableFiles	OUT A list to receive the files that may be removed.

Implemented in FBuildPatchAppManifest.

◆ GetVersionString()

virtual const FString & IBuildManifest::GetVersionString ( ) const

pure virtual

Get the string App version that this manifest describes

Returns: the version string

Implemented in FBuildPatchAppManifest.

◆ NeedsResaving()

virtual bool IBuildManifest::NeedsResaving ( ) const

pure virtual

Checks the manifest format version to see if this manifest was loaded from latest data

Returns: True if the manifest was created from the latest format

Implemented in FBuildPatchAppManifest.

◆ RemoveCustomField()

virtual void IBuildManifest::RemoveCustomField ( const FString & FieldName )

pure virtual

Remove a custom field from the manifest

Parameters

FieldName The name of the custom field

Implemented in FBuildPatchAppManifest.

◆ SetCustomField() [1/3]

virtual const IManifestFieldPtr IBuildManifest::SetCustomField	(	const FString &	FieldName,
		const double &	Value
	)

pure virtual

Implemented in FBuildPatchAppManifest.

◆ SetCustomField() [2/3]

virtual const IManifestFieldPtr IBuildManifest::SetCustomField	(	const FString &	FieldName,
		const FString &	Value
	)

pure virtual

Various functions for setting a custom field in the manifest

Parameters

FieldName	The name of the custom field
Value	The value for the field

Returns: An interface to the field that was created

Implemented in FBuildPatchAppManifest.

◆ SetCustomField() [3/3]

virtual const IManifestFieldPtr IBuildManifest::SetCustomField	(	const FString &	FieldName,
		const int64 &	Value
	)

pure virtual

Implemented in FBuildPatchAppManifest.

The documentation for this class was generated from the following file:

Engine/Source/Runtime/Online/BuildPatchServices/Public/Interfaces/IBuildManifest.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IBuildManifest()

Member Function Documentation

◆ CopyCustomFields()

◆ Duplicate()

◆ GetAppID()

◆ GetAppName()

◆ GetBuildFileList() [1/2]

◆ GetBuildFileList() [2/2]

◆ GetBuildFileListView() [1/2]

◆ GetBuildFileListView() [2/2]

◆ GetBuildSize() [1/2]

◆ GetBuildSize() [2/2]

◆ GetCustomField()

◆ GetDeltaDownloadSize() [1/2]

◆ GetDeltaDownloadSize() [2/2]

◆ GetDownloadSize() [1/2]

◆ GetDownloadSize() [2/2]

◆ GetFileHash()

◆ GetFileSize() [1/3]

◆ GetFileSize() [2/3]

◆ GetFileSize() [3/3]

◆ GetFileTagList() [1/2]

◆ GetFileTagList() [2/2]

◆ GetLaunchCommand()

◆ GetLaunchExe()

◆ GetOutdatedFiles()

◆ GetPrereqArgs()

◆ GetPrereqIds()

◆ GetPrereqName()

◆ GetPrereqPath()

◆ GetRemovableFiles() [1/2]

◆ GetRemovableFiles() [2/2]

◆ GetVersionString()

◆ NeedsResaving()

◆ RemoveCustomField()

◆ SetCustomField() [1/3]

◆ SetCustomField() [2/3]

◆ SetCustomField() [3/3]