LaunchBoxContributors
On this page

EmulatorUpdateCheckResult14.1

Class in Unbroken.LaunchBox.Plugins.Components.Emulators

C#
public sealed class EmulatorUpdateCheckResult
Represents the complete result of an emulator update check.

Constructors

EmulatorUpdateCheckResult

C#
public EmulatorUpdateCheckResult(
    EmulatorInstalledVersion installedVersion,
    IReadOnlyList<EmulatorRelease> installableVersions,
    EmulatorRelease? targetVersion,
    EmulatorVersionRelation versionRelation,
    EmulatorUpdateDisposition disposition
)
Initializes a complete emulator update-check result.
installedVersion
The installed version reported by the integration.
installableVersions
The complete, authoritative installable-release snapshot available when the check was performed.
targetVersion
The selected update target.
versionRelation
The relation of the installed version to the selected target.
disposition
The integration's authoritative update decision.

Properties

  • DispositionGets the integration's authoritative decision for the selected update target.
  • InstallableVersionsGets the complete, authoritative installable-release snapshot available when the check was performed.
  • InstalledVersionGets the installed version reported by the integration.
  • IsUpdateAvailableGets whether the selected target should be offered as an update.
  • TargetVersionGets the release selected as the update target.
  • VersionRelationGets the relation of the installed version to the selected target.

Disposition

C#
public EmulatorUpdateDisposition Disposition { get; }
Gets the integration's authoritative decision for the selected update target.

InstallableVersions

C#
public IReadOnlyList<EmulatorRelease> InstallableVersions { get; }
Gets the complete, authoritative installable-release snapshot available when the check was performed.

InstalledVersion

C#
public EmulatorInstalledVersion InstalledVersion { get; }
Gets the installed version reported by the integration.

IsUpdateAvailable

C#
public bool IsUpdateAvailable { get; }
Gets whether the selected target should be offered as an update.

TargetVersion

C#
public EmulatorRelease? TargetVersion { get; }
Gets the release selected as the update target.

VersionRelation

C#
public EmulatorVersionRelation VersionRelation { get; }
Gets the relation of the installed version to the selected target.

Methods

CreateUsingVersionLabelComparison(EmulatorInstalledVersion, IEnumerable<…>)

C#
public static EmulatorUpdateCheckResult CreateUsingVersionLabelComparison(
    EmulatorInstalledVersion installedVersion,
    IEnumerable<EmulatorRelease>? installableVersions
)
Creates the standard update decision from an installed version and one installable-release snapshot.
installedVersion
The installed version result.
installableVersions
The complete installable-release snapshot in preference order.

Returns

A result that selects the first release and compares its label with the installed version.

CreateUsingVersionLabelComparison(EmulatorUpdateCheckRequest, IEmulatorVersionCapability, IEmulatorInstallationCapability)

C#
public static EmulatorUpdateCheckResult CreateUsingVersionLabelComparison(
    EmulatorUpdateCheckRequest request,
    IEmulatorVersionCapability versionProvider,
    IEmulatorInstallationCapability installer
)
Queries independent version and installation capabilities once and creates the standard update decision.
request
The emulator record and effective application path to check.
versionProvider
The capability used to query the installed version.
installer
The capability used to query installable releases.

Returns

The standard update-check result.