RemovalPlan14.1
Class in Unbroken.LaunchBox.Plugins.Capabilities.Installation
public sealed class RemovalPlan
Describes exact provider-known files that the host may remove beneath bounded roots.
Remarks
A plan must identify at least one installed or receipt file unless confirmed whole-install-directory removal is required.Constructors
RemovalPlanInitializes a new instance of the RemovalPlan class.
RemovalPlan
public RemovalPlan(
string installDirectory,
IReadOnlyCollection<string> relativeInstalledFilePaths,
string? receiptDirectory = null,
IReadOnlyCollection<string>? relativeReceiptFilePaths = null,
bool allowInstallDirectoryFallback = false,
bool requiresInstallDirectoryFallback = false
)Initializes a new instance of the RemovalPlan class.
installDirectory- The item installation root.
relativeInstalledFilePaths- Exact file paths relative to the installation root.
receiptDirectory- An optional separate receipt root.
relativeReceiptFilePaths- Exact file paths relative to the receipt root.
allowInstallDirectoryFallback- Whether the host may offer confirmed whole-install-directory removal when exact removal cannot complete.
requiresInstallDirectoryFallback- Whether the provider knows that exact removal is unavailable and the allowed fallback is required.
Fields
MaximumFileCountSpecifies the maximum number of installed or receipt files in one collection.
MaximumFileCount
public const int MaximumFileCount = 1000000Specifies the maximum number of installed or receipt files in one collection.
Properties
AllowInstallDirectoryFallbackGets whether the host may offer confirmed whole-install-directory removal.InstallDirectoryGets the item installation root.ReceiptDirectoryGets the optional separate receipt root.RelativeInstalledFilePathsGets exact file paths relative to RemovalPlan.InstallDirectory.RelativeReceiptFilePathsGets exact file paths relative to RemovalPlan.ReceiptDirectory.RequiresInstallDirectoryFallbackGets whether the allowed whole-install-directory fallback is required.
AllowInstallDirectoryFallback
public bool AllowInstallDirectoryFallback { get; }Gets whether the host may offer confirmed whole-install-directory removal.
InstallDirectory
public string InstallDirectory { get; }Gets the item installation root.
ReceiptDirectory
public string? ReceiptDirectory { get; }Gets the optional separate receipt root.
RelativeInstalledFilePaths
public IReadOnlyCollection<string> RelativeInstalledFilePaths { get; }Gets exact file paths relative to RemovalPlan.InstallDirectory.
RelativeReceiptFilePaths
public IReadOnlyCollection<string> RelativeReceiptFilePaths { get; }Gets exact file paths relative to RemovalPlan.ReceiptDirectory.
RequiresInstallDirectoryFallback
public bool RequiresInstallDirectoryFallback { get; }Gets whether the allowed whole-install-directory fallback is required.