14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
GameRemovalPlan14.1 Beta
public sealed class Unbroken.LaunchBox.Plugins.GameInstallation.GameRemovalPlan
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
GameRemovalPlan 14.1 Beta
public GameRemovalPlan(string installDirectory, System.Collections.Generic.IReadOnlyCollection<string> relativeInstalledFilePaths, string? receiptDirectory = null, System.Collections.Generic.IReadOnlyCollection<string>? relativeReceiptFilePaths = null, bool allowInstallDirectoryFallback = false, bool requiresInstallDirectoryFallback = false)Initializes a new instance of the Unbroken.LaunchBox.Plugins.GameInstallation.GameRemovalPlan class.
installDirectory14.1 Beta- The game installation root.
relativeInstalledFilePaths14.1 Beta- Exact file paths relative to the installation root.
receiptDirectory14.1 Beta- An optional separate receipt root.
relativeReceiptFilePaths14.1 Beta- Exact file paths relative to the receipt root.
allowInstallDirectoryFallback14.1 Beta- Whether the host may offer confirmed whole-install-directory removal when exact removal cannot complete.
requiresInstallDirectoryFallback14.1 Beta- Whether the provider knows that exact removal is unavailable and the allowed fallback is required.
Fields
MaximumFileCount 14.1 Beta
public const int MaximumFileCount = 1000000Specifies the maximum number of installed or receipt files in one collection.
Properties
public bool AllowInstallDirectoryFallback { get; }public string InstallDirectory { get; }public string? ReceiptDirectory { get; }public System.Collections.Generic.IReadOnlyCollection<string> RelativeInstalledFilePaths { get; }public System.Collections.Generic.IReadOnlyCollection<string> RelativeReceiptFilePaths { get; }public bool RequiresInstallDirectoryFallback { get; }
AllowInstallDirectoryFallback 14.1 Beta
public bool AllowInstallDirectoryFallback { get; }Gets whether the host may offer confirmed whole-install-directory removal.
InstallDirectory 14.1 Beta
public string InstallDirectory { get; }Gets the game installation root.
ReceiptDirectory 14.1 Beta
public string? ReceiptDirectory { get; }Gets the optional separate receipt root.
RelativeInstalledFilePaths 14.1 Beta
public System.Collections.Generic.IReadOnlyCollection<string> RelativeInstalledFilePaths { get; }Gets exact file paths relative to Unbroken.LaunchBox.Plugins.GameInstallation.GameRemovalPlan.InstallDirectory.
RelativeReceiptFilePaths 14.1 Beta
public System.Collections.Generic.IReadOnlyCollection<string> RelativeReceiptFilePaths { get; }Gets exact file paths relative to Unbroken.LaunchBox.Plugins.GameInstallation.GameRemovalPlan.ReceiptDirectory.
RequiresInstallDirectoryFallback 14.1 Beta
public bool RequiresInstallDirectoryFallback { get; }Gets whether the allowed whole-install-directory fallback is required.