Class BackgroundOperation

Namespace

Playnite

Assembly

Playnite.SDK.dll

A base class for objects of which the properties must be observable.

public abstract class BackgroundOperation : ObservableObject, INotifyPropertyChanged, INotifyPropertyChanging, IAsyncDisposable

Inheritance

object

ObservableObject

BackgroundOperation

Implements

INotifyPropertyChanged

INotifyPropertyChanging

IAsyncDisposable

Inherited Members

ObservableObject.OnPropertyChanged(PropertyChangedEventArgs)

ObservableObject.OnPropertyChanging(PropertyChangingEventArgs)

ObservableObject.OnPropertyChanged(string)

ObservableObject.OnPropertyChanging(string)

ObservableObject.SetProperty<T>(ref T, T, string)

ObservableObject.SetProperty<T>(ref T, T, IEqualityComparer<T>, string)

ObservableObject.SetProperty<T>(T, T, Action<T>, string)

ObservableObject.SetProperty<T>(T, T, IEqualityComparer<T>, Action<T>, string)

ObservableObject.SetProperty<TModel, T>(T, T, TModel, Action<TModel, T>, string)

ObservableObject.SetProperty<TModel, T>(T, T, IEqualityComparer<T>, TModel, Action<TModel, T>, string)

ObservableObject.SetPropertyAndNotifyOnCompletion(ref ObservableObject.TaskNotifier, Task, string)

ObservableObject.SetPropertyAndNotifyOnCompletion(ref ObservableObject.TaskNotifier, Task, Action<Task>, string)

ObservableObject.SetPropertyAndNotifyOnCompletion<T>(ref ObservableObject.TaskNotifier<T>, Task<T>, string)

ObservableObject.SetPropertyAndNotifyOnCompletion<T>(ref ObservableObject.TaskNotifier<T>, Task<T>, Action<Task<T>>, string)

ObservableObject.PropertyChanged

ObservableObject.PropertyChanging

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BackgroundOperation(string, string)

public BackgroundOperation(string id, string name)

Parameters

id string

name string

Properties

Id

public string Id { get; }

Property Value

string

Name

[ExcludeFromCodeCoverage]
public string Name { get; set; }

Property Value

string

Pausable

[ExcludeFromCodeCoverage]
public bool Pausable { get; set; }

Property Value

bool

ProgressIsIndeterminate

[ExcludeFromCodeCoverage]
public bool ProgressIsIndeterminate { get; set; }

Property Value

bool

ProgressMaximum

[ExcludeFromCodeCoverage]
public double ProgressMaximum { get; set; }

Property Value

double

ProgressValue

[ExcludeFromCodeCoverage]
public double ProgressValue { get; set; }

Property Value

double

Status

[ExcludeFromCodeCoverage]
public string Status { get; set; }

Property Value

string

Methods

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public virtual ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

OperationFailedAsync(FailedEventArgs)

protected Task OperationFailedAsync(BackgroundOperation.FailedEventArgs args)

Parameters

args BackgroundOperation.FailedEventArgs

Returns

Task

OperationFinishedAsync(FinishedEventArgs)

protected Task OperationFinishedAsync(BackgroundOperation.FinishedEventArgs args)

Parameters

args BackgroundOperation.FinishedEventArgs

Returns

Task

PauseAsync(PauseArgs)

public virtual Task PauseAsync(BackgroundOperation.PauseArgs args)

Parameters

args BackgroundOperation.PauseArgs

Returns

Task

ResumeAsync(ResumeArgs)

public virtual Task ResumeAsync(BackgroundOperation.ResumeArgs args)

Parameters

args BackgroundOperation.ResumeArgs

Returns

Task

StartAsync(StartArgs)

public abstract Task StartAsync(BackgroundOperation.StartArgs args)

Parameters

args BackgroundOperation.StartArgs

Returns

Task

StopAsync(StopArgs)

public abstract Task StopAsync(BackgroundOperation.StopArgs args)

Parameters

args BackgroundOperation.StopArgs

Returns

Task