Class UpdatingSession

Namespace

CarinaStudio.AutoUpdate.ViewModels

Assembly

CarinaStudio.AppBase.AutoUpdate.dll

Base class of view-model of auto updating session.

public abstract class UpdatingSession : ViewModel, IDisposable, IApplicationObject, IThreadDependent, ISynchronizable, INotifyPropertyChanged

Inheritance

object

BaseDisposable

ViewModel

UpdatingSession

Implements

IDisposable

IApplicationObject

IThreadDependent

ISynchronizable

INotifyPropertyChanged

Inherited Members

ViewModel.HasNecessaryTasksProperty

ViewModel.OwnerProperty

ViewModel.AddResource(IDisposable)

ViewModel.AddResource(IAsyncDisposable)

ViewModel.AddResource(Func<Task>, Func<Task>)

ViewModel.AddResource(Action, Action)

ViewModel.AddResources(params IDisposable[])

ViewModel.AddResources(params IAsyncDisposable[])

ViewModel.Application

ViewModel.CheckAccess()

ViewModel.CoerceValue<T>(ObservableProperty<T>, T)

ViewModel.GetValue<T>(ObservableProperty<T>)

ViewModel.GetValueAsObservable<T>(ObservableProperty<T>)

ViewModel.HasNecessaryTasks

ViewModel.Id

ViewModel.Logger

ViewModel.OnApplicationPropertyChanged(PropertyChangedEventArgs)

ViewModel.OnApplicationStringsUpdated()

ViewModel.OnOwnerChanged(ViewModel, ViewModel)

ViewModel.OnOwnedViewModelAdded(ViewModel)

ViewModel.OnOwnedViewModelRemoved(ViewModel)

ViewModel.OnPropertyChanged(string)

ViewModel.OnSettingChanged(SettingChangedEventArgs)

ViewModel.OnSettingChanging(SettingChangingEventArgs)

ViewModel.OwnedViewModels

ViewModel.Owner

ViewModel.PersistentState

ViewModel.PropertyChanged

ViewModel.ResetValue<T>(ObservableProperty<T>)

ViewModel.Settings

ViewModel.SetValue<T>(ObservableProperty<T>, T)

ViewModel.SynchronizationContext

ViewModel.ToString()

ViewModel.WaitForNecessaryTaskAsync(Task)

ViewModel.WaitForNecessaryTasksAsync()

BaseDisposable.Dispose()

BaseDisposable.IsDisposed

BaseDisposable.VerifyDisposed()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

DisposableExtensions.DisposeAndReturnNull<T>(T?)

DisposableExtensions.ExchangeAsync<T, R>(T, Func<T, Task<R?>>)

DisposableExtensions.ExchangeAsync<T, R>(T, Func<Task<R?>>)

DisposableExtensions.Exchange<T, R>(T, Func<T, R?>)

DisposableExtensions.Exchange<T, R>(T, Func<R?>)

DisposableExtensions.SetupAsync<T>(T, Func<T, Task>)

DisposableExtensions.SetupAsync<T>(T, Func<Task>)

DisposableExtensions.Setup<T>(T, Action)

DisposableExtensions.Setup<T>(T, Action<T>)

DisposableExtensions.UseAsync<T>(T, Func<T, Task>)

DisposableExtensions.UseAsync<T, R>(T, Func<T, Task<R>>)

DisposableExtensions.Use<T>(T, Action<T>)

DisposableExtensions.Use<T, R>(T, RefOutFunc<T, R>)

DisposableExtensions.Use<T, R>(T, Func<T, R>)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, Action)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, EventHandler)

ObjectExtensions.AddWeakEventHandler<TObject, TArg>(TObject, string, Action<TArg>)

ObjectExtensions.AddWeakEventHandler<TObject, TArgs>(TObject, string, EventHandler<TArgs>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2>(TObject, string, Action<TArg1, TArg2>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2, TArg3>(TObject, string, Action<TArg1, TArg2, TArg3>)

ObjectExtensions.AlsoAsync<T>(T, Func<T, Task>)

ObjectExtensions.Also<T>(T, Action<T>)

ObjectExtensions.AsNonNull<T>(T?)

ObjectExtensions.LetAsync<T>(T, Func<T, Task>)

ObjectExtensions.LetAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.Let<T>(T, Action<T>)

ObjectExtensions.Let<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Let<T, R>(T, Func<T, R>)

ObjectExtensions.LockAsync<T>(T, Func<T, Task>)

ObjectExtensions.LockAsync<T>(T, Func<Task>)

ObjectExtensions.LockAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.LockAsync<T, R>(T, Func<Task<R>>)

ObjectExtensions.Lock<T>(T, Action)

ObjectExtensions.Lock<T>(T, Action<T>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<R>)

ObjectExtensions.Lock<T, R>(T, Func<T, R>)

ObjectExtensions.Lock<T, R>(T, Func<R>)

ThreadDependentExtensions.VerifyAccess(IThreadDependent)

NotifyPropertyChangedExtensions.AddWeakPropertyChangedEventHandler(INotifyPropertyChanged, PropertyChangedEventHandler)

NotifyPropertyChangedExtensions.WaitForPropertyAsync(INotifyPropertyChanged, string, object?, int, CancellationToken?)

ObjectExtensions.TryCastAndRunAsync<T>(object?, Func<T, Task>)

ObjectExtensions.TryCastAndRunAsync<T, R>(object?, Func<T, Task<R>>)

ObjectExtensions.TryCastAndRun<T>(object?, Action<T>)

ObjectExtensions.TryCastAndRun<T, R>(object?, Func<T, R>)

Constructors

UpdatingSession(IApplication)

Initialize new UpdatingSession instance.

protected UpdatingSession(IApplication app)

Parameters

app IApplication

Application.

Fields

ApplicationNameProperty

Property of ApplicationName

public static readonly ObservableProperty<string?> ApplicationNameProperty

Field Value

ObservableProperty<string>

DownloadedPackageSizeProperty

Property of DownloadedPackageSize

public static readonly ObservableProperty<long> DownloadedPackageSizeProperty

Field Value

ObservableProperty<long>

IsBackingUpApplicationProperty

Property of IsBackingUpApplication

public static readonly ObservableProperty<bool> IsBackingUpApplicationProperty

Field Value

ObservableProperty<bool>

IsDownloadingPackageProperty

Property of IsDownloadingPackage

public static readonly ObservableProperty<bool> IsDownloadingPackageProperty

Field Value

ObservableProperty<bool>

IsInstallingPackageProperty

Property of IsInstallingPackage

public static readonly ObservableProperty<bool> IsInstallingPackageProperty

Field Value

ObservableProperty<bool>

IsProgressAvailableProperty

Property of IsProgressAvailable

public static readonly ObservableProperty<bool> IsProgressAvailableProperty

Field Value

ObservableProperty<bool>

IsRefreshingApplicationIconProperty

Property of IsRefreshingApplicationIcon

public static readonly ObservableProperty<bool> IsRefreshingApplicationIconProperty

Field Value

ObservableProperty<bool>

IsResolvingPackageProperty

Property of IsResolvingPackage

public static readonly ObservableProperty<bool> IsResolvingPackageProperty

Field Value

ObservableProperty<bool>

IsRestoringApplicationProperty

Property of IsRestoringApplication

public static readonly ObservableProperty<bool> IsRestoringApplicationProperty

Field Value

ObservableProperty<bool>

IsUpdatingCancelledProperty

Property of IsUpdatingCancelled

public static readonly ObservableProperty<bool> IsUpdatingCancelledProperty

Field Value

ObservableProperty<bool>

IsUpdatingCancellingProperty

Property of IsUpdatingCancelling

public static readonly ObservableProperty<bool> IsUpdatingCancellingProperty

Field Value

ObservableProperty<bool>

IsUpdatingCompletedProperty

Property of IsUpdatingCompleted

public static readonly ObservableProperty<bool> IsUpdatingCompletedProperty

Field Value

ObservableProperty<bool>

IsUpdatingFailedProperty

Property of IsUpdatingFailed

public static readonly ObservableProperty<bool> IsUpdatingFailedProperty

Field Value

ObservableProperty<bool>

IsUpdatingProperty

Property of IsUpdating

public static readonly ObservableProperty<bool> IsUpdatingProperty

Field Value

ObservableProperty<bool>

IsUpdatingSucceededProperty

Property of IsUpdatingSucceeded

public static readonly ObservableProperty<bool> IsUpdatingSucceededProperty

Field Value

ObservableProperty<bool>

IsVerifyingPackageProperty

Property of IsVerifyingPackage

public static readonly ObservableProperty<bool> IsVerifyingPackageProperty

Field Value

ObservableProperty<bool>

MessageProperty

Property of Message

public static readonly ObservableProperty<string?> MessageProperty

Field Value

ObservableProperty<string>

PackageSizeProperty

Property of PackageSize

public static readonly ObservableProperty<long?> PackageSizeProperty

Field Value

ObservableProperty<long?>

ProgressPercentageProperty

Property of ProgressPercentage

public static readonly ObservableProperty<double> ProgressPercentageProperty

Field Value

ObservableProperty<double>

RefreshApplicationIconAutomaticallyProperty

Property of RefreshApplicationIconAutomatically

public static readonly ObservableProperty<bool> RefreshApplicationIconAutomaticallyProperty

Field Value

ObservableProperty<bool>

RefreshApplicationIconMessageProperty

Property of RefreshApplicationIconMessage

public static readonly ObservableProperty<string?> RefreshApplicationIconMessageProperty

Field Value

ObservableProperty<string>

Properties

ApplicationBaseVersion

Get or set base version of application to update.

public Version? ApplicationBaseVersion { get; set; }

Property Value

Version

ApplicationDirectoryPath

Get or set path to directory of application to update.

public string? ApplicationDirectoryPath { get; set; }

Property Value

string

ApplicationName

Get or set name of application to update.

public string? ApplicationName { get; set; }

Property Value

string

CancelUpdatingCommand

Command to cancel updating process.

public ICommand CancelUpdatingCommand { get; }

Property Value

ICommand

DownloadedPackageSize

Get size of downloaded package in bytes.

public long DownloadedPackageSize { get; }

Property Value

long

IsBackingUpApplication

Check whether application is being backed-up or not.

public bool IsBackingUpApplication { get; }

Property Value

bool

IsDownloadingPackage

Check whether update package is being downloaded or not.

public bool IsDownloadingPackage { get; }

Property Value

bool

IsInstallingPackage

Check whether update package is being installed or not.

public bool IsInstallingPackage { get; }

Property Value

bool

IsProgressAvailable

Check whether progress of updating is available or not.

public bool IsProgressAvailable { get; }

Property Value

bool

IsRefreshingApplicationIcon

Check whether application icon refreshing is being performed or not.

public bool IsRefreshingApplicationIcon { get; }

Property Value

bool

IsResolvingPackage

Check whether update package is being resolved or not.

public bool IsResolvingPackage { get; }

Property Value

bool

IsRestoringApplication

Check whether application is being restored or not.

public bool IsRestoringApplication { get; }

Property Value

bool

IsUpdating

Check whether updating processing is on-going or not.

public bool IsUpdating { get; }

Property Value

bool

IsUpdatingCancelled

Check whether updating processing is cancelled or not.

public bool IsUpdatingCancelled { get; }

Property Value

bool

IsUpdatingCancelling

Check whether updating processing is being cancelled or not.

public bool IsUpdatingCancelling { get; }

Property Value

bool

IsUpdatingCompleted

Check whether updating processing is completed either successfully or unsuccessfully.

public bool IsUpdatingCompleted { get; }

Property Value

bool

IsUpdatingFailed

Check whether updating processing is completed unsuccessfully or not.

public bool IsUpdatingFailed { get; }

Property Value

bool

IsUpdatingSucceeded

Check whether updating processing is completed successfully or not.

public bool IsUpdatingSucceeded { get; }

Property Value

bool

IsVerifyingPackage

Check whether downloaded update package is being verified or not.

public bool IsVerifyingPackage { get; }

Property Value

bool

Message

Get message which describes status of updating.

public string? Message { get; }

Property Value

string

PackageManifestSource

Get or set source of package manifest.

public IStreamProvider? PackageManifestSource { get; set; }

Property Value

IStreamProvider

PackageRequestHeaders

Get collection of custom headers for requesting package download.

public IDictionary<string, string> PackageRequestHeaders { get; }

Property Value

IDictionary<string, string>

PackageSize

Get size of package in bytes.

public long? PackageSize { get; }

Property Value

long?

ProgressPercentage

Get current progress of updating in percentage. NaN if progress is unavailable.

public double ProgressPercentage { get; }

Property Value

double

RefreshApplicationIconAutomatically

Get or set whether refreshing application should be performed when needed or not.

public bool RefreshApplicationIconAutomatically { get; set; }

Property Value

bool

RefreshApplicationIconMessage

Get or set message for refreshing application icon.

public string? RefreshApplicationIconMessage { get; set; }

Property Value

string

SelfContainedPackageOnly

Get or set whether only self-contained update package can be selected or not.

public bool SelfContainedPackageOnly { get; set; }

Property Value

bool

StartUpdatingCommand

Command to start updating process.

public ICommand StartUpdatingCommand { get; }

Property Value

ICommand

UpdaterProgress

Get progress reported by internal Updater.

protected double UpdaterProgress { get; }

Property Value

double

UpdaterState

Get state of internal Updater.

protected UpdaterState UpdaterState { get; }

Property Value

UpdaterState

UpdatingVersion

Get version of application which is updating to.

protected Version? UpdatingVersion { get; }

Property Value

Version

Methods

CreatePackageResolver(IStreamProvider)

Create IPackageResolver before updating process start.

protected virtual IPackageResolver CreatePackageResolver(IStreamProvider source)

Parameters

source IStreamProvider

Source of package manifest.

Returns

IPackageResolver

IPackageResolver.

Remarks

Will create XmlPackageResolver by default implementation.

Dispose(bool)

Dispose the instance.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True to dispose managed resources.

OnPropertyChanged(ObservableProperty, object?, object?)

Called when property changed.

protected override void OnPropertyChanged(ObservableProperty property, object? oldValue, object? newValue)

Parameters

property ObservableProperty

Changed property.

oldValue object

Old value.

newValue object

New value.

OnUpdaterProgressChanged()

Called when progress reported by internal Updater changed.

protected virtual void OnUpdaterProgressChanged()

OnUpdaterStateChanged()

Called when state of internal Updater changed.

protected virtual void OnUpdaterStateChanged()