#include <BuildPatchSettings.h>

Public Member Functions
BUILDPATCHSERVICES_API	FInstallerAction (const FInstallerAction &CopyFrom)

BUILDPATCHSERVICES_API	FInstallerAction (FInstallerAction &&MoveFrom)

BUILDPATCHSERVICES_API bool	IsInstall () const

BUILDPATCHSERVICES_API bool	IsUpdate () const

BUILDPATCHSERVICES_API bool	IsRepair () const

BUILDPATCHSERVICES_API bool	IsUninstall () const

BUILDPATCHSERVICES_API const TSet< FString > &	GetInstallTags () const

BUILDPATCHSERVICES_API const FString &	GetInstallSubdirectory () const

BUILDPATCHSERVICES_API const FString &	GetCloudSubdirectory () const

BUILDPATCHSERVICES_API IBuildManifestRef	GetCurrentManifest () const

BUILDPATCHSERVICES_API IBuildManifestRef	GetInstallManifest () const

IBuildManifestPtr	TryGetCurrentManifest () const

IBuildManifestPtr	TryGetInstallManifest () const

IBuildManifestRef	GetCurrentOrInstallManifest () const

IBuildManifestRef	GetInstallOrCurrentManifest () const

Static Public Member Functions
static BUILDPATCHSERVICES_API FInstallerAction	MakeInstall (const IBuildManifestRef &Manifest, TSet< FString > InstallTags=TSet< FString >(), FString InstallSubdirectory=FString(), FString CloudSubdirectory=FString())

static BUILDPATCHSERVICES_API FInstallerAction	MakeUpdate (const IBuildManifestRef &CurrentManifest, const IBuildManifestRef &InstallManifest, TSet< FString > InstallTags=TSet< FString >(), FString InstallSubdirectory=FString(), FString CloudSubdirectory=FString())

static BUILDPATCHSERVICES_API FInstallerAction	MakeRepair (const IBuildManifestRef &Manifest, TSet< FString > InstallTags=TSet< FString >(), FString InstallSubdirectory=FString(), FString CloudSubdirectory=FString())

static BUILDPATCHSERVICES_API FInstallerAction	MakeUninstall (const IBuildManifestRef &Manifest, FString InstallSubdirectory=FString(), FString CloudSubdirectory=FString())

static FInstallerAction	MakeInstallOrUpdate (const IBuildManifestPtr &CurrentManifest, const IBuildManifestRef &InstallManifest, TSet< FString > InstallTags=TSet< FString >(), FString InstallSubdirectory=FString(), FString CloudSubdirectory=FString())

Constructor & Destructor Documentation

◆ FInstallerAction() [1/2]

BuildPatchServices::FInstallerAction::FInstallerAction ( const FInstallerAction & CopyFrom )

Copy constructor.

◆ FInstallerAction() [2/2]

BuildPatchServices::FInstallerAction::FInstallerAction ( FInstallerAction && MoveFrom )

RValue constructor to allow move semantics.

Member Function Documentation

◆ GetCloudSubdirectory()

const FString & BuildPatchServices::FInstallerAction::GetCloudSubdirectory ( ) const

Returns: the cloud subdirectory for the action.

◆ GetCurrentManifest()

IBuildManifestRef BuildPatchServices::FInstallerAction::GetCurrentManifest ( ) const

Returns: the manifest for the current installation, this will runtime assert if called invalidly (see TryGetCurrentManifest).

◆ GetCurrentOrInstallManifest()

IBuildManifestRef BuildPatchServices::FInstallerAction::GetCurrentOrInstallManifest ( ) const

inline

Helper for getting the current manifest, or install manifest if no current manifest. One will always be valid.

Returns: the current, or the install manifest, based on validity respectively.

◆ GetInstallManifest()

IBuildManifestRef BuildPatchServices::FInstallerAction::GetInstallManifest ( ) const

Returns: the manifest for the desired installation, this will runtime assert if called invalidly (see TryGetInstallManifest).

◆ GetInstallOrCurrentManifest()

IBuildManifestRef BuildPatchServices::FInstallerAction::GetInstallOrCurrentManifest ( ) const

inline

Helper for getting the install manifest, or current manifest if no install manifest. One will always be valid.

Returns: the install, or the current manifest, based on validity respectively.

◆ GetInstallSubdirectory()

const FString & BuildPatchServices::FInstallerAction::GetInstallSubdirectory ( ) const

Returns: the install subdirectory for the action.

◆ GetInstallTags()

const TSet< FString > & BuildPatchServices::FInstallerAction::GetInstallTags ( ) const

Returns: the install tags for the action.

◆ IsInstall()

bool BuildPatchServices::FInstallerAction::IsInstall ( ) const

Returns: true if this action intent is to perform a fresh installation.

◆ IsRepair()

bool BuildPatchServices::FInstallerAction::IsRepair ( ) const

Returns: true if this action intent is to repair an existing installation.

◆ IsUninstall()

bool BuildPatchServices::FInstallerAction::IsUninstall ( ) const

Returns: true if this action intent is to uninstall an installation.

◆ IsUpdate()

bool BuildPatchServices::FInstallerAction::IsUpdate ( ) const

Returns: true if this action intent is to update an existing installation.

◆ MakeInstall()

BuildPatchServices::FInstallerAction BuildPatchServices::FInstallerAction::MakeInstall	(	const IBuildManifestRef &	Manifest,
		TSet< FString >	InstallTags = `TSet<FString>()`,
		FString	InstallSubdirectory = `FString()`,
		FString	CloudSubdirectory = `FString()`
	)

static

Creates an install action.

Parameters

Manifest	The manifest for the build to be installed.
InstallTags	The install tags to use if selectively installing files. If empty set, all files will be installed.
InstallSubdirectory	The subdirectory to install this data to inside of the main install directory.
CloudSubdirectory	The subdirectory of the cloud distribution root that this patch data should be sourced.

Returns: the action setup for performing an installation.

◆ MakeInstallOrUpdate()

static FInstallerAction BuildPatchServices::FInstallerAction::MakeInstallOrUpdate	(	const IBuildManifestPtr &	CurrentManifest,
		const IBuildManifestRef &	InstallManifest,
		TSet< FString >	InstallTags = `TSet<FString>()`,
		FString	InstallSubdirectory = `FString()`,
		FString	CloudSubdirectory = `FString()`
	)

inlinestatic

Helper for creating an install action or update action based on validity of CurrentManifest.

Parameters

CurrentManifest	The manifest for the build currently installed, invalid if no build installed.
InstallManifest	The manifest for the build to be installed.
InstallTags	The install tags to use if selectively installing files. If empty set, all files will be installed/updated, or added if missing.
InstallSubdirectory	The subdirectory to install this data to inside of the main install directory.
CloudSubdirectory	The subdirectory of the cloud distribution root that this patch data should be sourced.

Returns: the action setup for performing an install or update.

◆ MakeRepair()

BuildPatchServices::FInstallerAction BuildPatchServices::FInstallerAction::MakeRepair	(	const IBuildManifestRef &	Manifest,
		TSet< FString >	InstallTags = `TSet<FString>()`,
		FString	InstallSubdirectory = `FString()`,
		FString	CloudSubdirectory = `FString()`
	)

static

Creates an install action.

Parameters

Manifest	The manifest for the build to be installed.
InstallTags	The install tags to use if selectively installing files. If empty set, all files will be repaired.
InstallSubdirectory	The subdirectory to install this data to inside of the main install directory.
CloudSubdirectory	The subdirectory of the cloud distribution root that this patch data should be sourced.

Returns: the action setup forcing an SHA check, and repair of all tagged files.

◆ MakeUninstall()

BuildPatchServices::FInstallerAction BuildPatchServices::FInstallerAction::MakeUninstall	(	const IBuildManifestRef &	Manifest,
		FString	InstallSubdirectory = `FString()`,
		FString	CloudSubdirectory = `FString()`
	)

static

Creates an uninstall action.

Parameters

Manifest	The manifest for the build currently installed.
InstallSubdirectory	The subdirectory to install this data to inside of the main install directory.
CloudSubdirectory	The subdirectory of the cloud distribution root that this patch data should be sourced.

Returns: the action setup for performing an uninstall, deleting all files referenced by the manifest.

◆ MakeUpdate()

BuildPatchServices::FInstallerAction BuildPatchServices::FInstallerAction::MakeUpdate	(	const IBuildManifestRef &	CurrentManifest,
		const IBuildManifestRef &	InstallManifest,
		TSet< FString >	InstallTags = `TSet<FString>()`,
		FString	InstallSubdirectory = `FString()`,
		FString	CloudSubdirectory = `FString()`
	)

static

Creates an update action.

Parameters

CurrentManifest	The manifest for the build currently installed.
InstallManifest	The manifest for the build to be installed.
InstallTags	The install tags to use if selectively installing files. If empty set, all files will be updated, or added if missing.
InstallSubdirectory	The subdirectory to install this data to inside of the main install directory.
CloudSubdirectory	The subdirectory of the cloud distribution root that this patch data should be sourced.

Returns: the action setup for performing an update.

◆ TryGetCurrentManifest()

IBuildManifestPtr BuildPatchServices::FInstallerAction::TryGetCurrentManifest ( ) const

inline

Helper for getting the current manifest if nullable is preferred.

Returns: the manifest for the current installation, if valid.

◆ TryGetInstallManifest()

IBuildManifestPtr BuildPatchServices::FInstallerAction::TryGetInstallManifest ( ) const

inline

Helper for getting the install manifest if nullable is preferred.

Returns: true is this action intent it to perform a fresh installation.

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

Engine/Source/Runtime/Online/BuildPatchServices/Public/BuildPatchSettings.h
Engine/Source/Runtime/Online/BuildPatchServices/Private/BuildPatchSettings.cpp

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ FInstallerAction() [1/2]

◆ FInstallerAction() [2/2]

Member Function Documentation

◆ GetCloudSubdirectory()

◆ GetCurrentManifest()

◆ GetCurrentOrInstallManifest()

◆ GetInstallManifest()

◆ GetInstallOrCurrentManifest()

◆ GetInstallSubdirectory()

◆ GetInstallTags()

◆ IsInstall()

◆ IsRepair()

◆ IsUninstall()

◆ IsUpdate()

◆ MakeInstall()

◆ MakeInstallOrUpdate()

◆ MakeRepair()

◆ MakeUninstall()

◆ MakeUpdate()

◆ TryGetCurrentManifest()

◆ TryGetInstallManifest()