LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IPluginProgressNotification14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Notifications.IPluginProgressNotification : Unbroken.LaunchBox.Plugins.Notifications.IPluginNotification
Represents an active progress notification that a plugin can update or finish.

Inheritance and interfaces

Properties

IsInProgress 14.1 Beta

C#
bool IsInProgress { get; }
Gets whether the operation is still in progress.

Methods

CompleteAsync 14.1 Beta

C#
System.Threading.Tasks.Task CompleteAsync(Unbroken.LaunchBox.Plugins.Notifications.PluginProgressCompletionArgs args, System.Threading.CancellationToken cancellationToken)
Finishes the progress notification successfully without changing its read state or presenting it again. Repeated calls have no effect.
args 14.1 Beta
The final message and notification settings.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

A task representing the completion request.

FailAsync 14.1 Beta

C#
System.Threading.Tasks.Task FailAsync(Unbroken.LaunchBox.Plugins.Notifications.PluginProgressCompletionArgs args, System.Threading.CancellationToken cancellationToken)
Finishes the progress notification as an error without changing its read state or presenting it again. Repeated calls have no effect.
args 14.1 Beta
The final error message and notification settings.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

A task representing the failure-notification request.

UpdateAsync 14.1 Beta

C#
System.Threading.Tasks.Task UpdateAsync(Unbroken.LaunchBox.Plugins.Notifications.PluginProgressUpdateArgs args, System.Threading.CancellationToken cancellationToken)
Updates the active progress notification without changing its read state or presenting it again. The operation has no effect after it has finished or been dismissed.
args 14.1 Beta
The notification values to change. Null properties retain their current values.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

A task representing the notification update.