Interface ITask

Represents an operation that can be cancelled and have its progress tracked.

public interface ITask

Extension Methods: BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, string, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Properties

Indicates whether this task can be canceled once it has been started.

bool CanCancel { get; }

A name describing the task in human-readable form.

string Name { get; }

An object used to associate the task with a specific process; can be null.

object? Tag { get; set; }

Runs the task and blocks until it is complete.

void Run(CancellationToken cancellationToken = default, ICredentialProvider? credentialProvider = null, IProgress<TaskSnapshot>? progress = null)

cancellationToken CancellationToken: Used to receive a signal (e.g. from another thread) when the user wants to cancel the task.
credentialProvider ICredentialProvider: Object used to retrieve credentials for specific Uris on demand; can be null.
progress IProgress<TaskSnapshot>: Used to report back the task's progress (e.g. to another thread).