LaunchBoxContributors
On this page

IPluginProgressNotification14.1

Interface in Unbroken.LaunchBox.Plugins.Services.Notifications

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

Inheritance and interfaces

Properties

  • IsInProgressGets whether the operation is still in progress.

IsInProgress

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

Methods

  • CompleteAsyncFinishes the progress notification successfully without changing its read state or presenting it again. Repeated calls have no effect.
  • FailAsyncFinishes the progress notification as an error without changing its read state or presenting it again. Repeated calls have no effect.
  • UpdateAsyncUpdates 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.

CompleteAsync

C#
Task CompleteAsync(
    PluginProgressCompletionRequest request,
    CancellationToken cancellationToken
)
Finishes the progress notification successfully without changing its read state or presenting it again. Repeated calls have no effect.
request
The final message and notification settings.
cancellationToken
A token used to cancel the operation.

Returns

A task representing the completion request.

FailAsync

C#
Task FailAsync(
    PluginProgressCompletionRequest request,
    CancellationToken cancellationToken
)
Finishes the progress notification as an error without changing its read state or presenting it again. Repeated calls have no effect.
request
The final error message and notification settings.
cancellationToken
A token used to cancel the operation.

Returns

A task representing the failure-notification request.

UpdateAsync

C#
Task UpdateAsync(
    PluginProgressUpdateRequest request,
    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.
request
The notification values to change. Null properties retain their current values.
cancellationToken
A token used to cancel the operation.

Returns

A task representing the notification update.