LaunchBoxContributors
On this page

EmulatorInstallRequest14.1

Class in Unbroken.LaunchBox.Plugins.Components.Emulators

C#
public sealed class EmulatorInstallRequest
Provides the context for an emulator installation or update.

Constructors

EmulatorInstallRequest

C#
public EmulatorInstallRequest(
    string platform,
    Action<string, string?, double?> reportProgressAction,
    Func<bool> cancelFunc,
    IEmulator? existingEmulator = null,
    EmulatorRelease? targetRelease = null,
    bool createEmulator = true
)
Initializes an emulator installation or update request.
platform
The platform for which the emulator is being installed.
reportProgressAction
The callback used to report status and progress.
cancelFunc
The callback used to determine whether cancellation was requested.
existingEmulator
The existing emulator record when updating or reinstalling.
targetRelease
The exact release selected by the host, or null to use the default.
createEmulator
Whether the installation should create a LaunchBox emulator record.

Properties

  • ExistingEmulatorGets the existing emulator record when updating or reinstalling.
  • PlatformGets the platform for which the emulator is being installed.
  • ReportProgressActionGets the callback used to report status and progress.
  • ShouldCancelFuncGets the callback used to determine whether cancellation was requested.
  • ShouldCreateEmulatorGets whether the installation should create a LaunchBox emulator record.
  • TargetReleaseGets the exact release selected by the host, or null to use the integration's default release.

ExistingEmulator

C#
public IEmulator? ExistingEmulator { get; }
Gets the existing emulator record when updating or reinstalling.

Platform

C#
public string Platform { get; }
Gets the platform for which the emulator is being installed.

ReportProgressAction

C#
public Action<string, string?, double?> ReportProgressAction { get; }
Gets the callback used to report status and progress.

ShouldCancelFunc

C#
public Func<bool> ShouldCancelFunc { get; }
Gets the callback used to determine whether cancellation was requested.

ShouldCreateEmulator

C#
public bool ShouldCreateEmulator { get; }
Gets whether the installation should create a LaunchBox emulator record.

TargetRelease

C#
public EmulatorRelease? TargetRelease { get; }
Gets the exact release selected by the host, or null to use the integration's default release.