LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

EmulatorImportActionRequest14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Emulators.EmulatorImportActionRequest
Provides the context for executing a selected emulator import action.

Constructors

EmulatorImportActionRequest 14.1 Beta

C#
public EmulatorImportActionRequest(string actionId, System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IGame> importedGames, System.Action<string, double?> reportProgress, System.Func<bool> isCancelled)
Initializes an emulator import-action request.
actionId 14.1 Beta
The integration-scoped identifier of the selected action.
importedGames 14.1 Beta
The games created by the import.
reportProgress 14.1 Beta
The callback used to report status and progress.
isCancelled 14.1 Beta
The callback used to determine whether cancellation was requested.

Properties

ActionId 14.1 Beta

C#
public string ActionId { get; }
Gets the integration-scoped identifier of the selected action.

ImportedGames 14.1 Beta

C#
public System.Collections.Generic.IList<Unbroken.LaunchBox.Plugins.Data.IGame> ImportedGames { get; }
Gets the games created by the import.

Methods

ReportActionProgress 14.1 Beta

C#
public void ReportActionProgress(string label, double? progress)
Reports progress for the selected action.
label 14.1 Beta
The current status label.
progress 14.1 Beta
The current progress value.

ShouldCancelAction 14.1 Beta

C#
public bool ShouldCancelAction()
Gets whether cancellation was requested.

Returns

true when cancellation was requested.