WindowsVelopackLocator class

Namespace: Velopack.Locators

An implementation for Windows which uses the default paths.

public class WindowsVelopackLocator : VelopackLocator, IVelopackLocator

Inherits: VelopackLocator
Implements: IVelopackLocator

Constructors

Constructor	Summary
WindowsVelopackLocator	An implementation for Windows which uses the default paths.

WindowsVelopackLocator(processImpl, customLog)

public WindowsVelopackLocator(IProcessImpl? processImpl, IVelopackLogger? customLog)

An implementation for Windows which uses the default paths.

Parameters

Name	Type	Description
processImpl	IProcessImpl
customLog	IVelopackLogger

Properties

Property	Summary
AppId	The unique application Id. This is used in various app paths.
RootAppDir	The root directory of the application. On Windows, this folder contains all
UpdateExePath	The path to the current Update.exe or similar on other operating systems.
AppContentDir	The directory in which versioned application files are stored.
CurrentlyInstalledVersion	The currently installed version of the application, or null if the app is not installed.
PackagesDir	The directory in which nupkg files are stored for this application.
IsPortable	A flag indicating if this is a portable build, and that the settings should be self-contained in the package.
Process	Provides an abstraction for dealing with the dotnet Process API. This is used to start processes and
Channel	The release channel this package was built for.
AppUserModelId	The Application User Model ID for this app, used for taskbar grouping and toast notifications on Windows.

AppId

public override string? AppId { get; }

The unique application Id. This is used in various app paths.

RootAppDir

public override string? RootAppDir { get; }

The root directory of the application. On Windows, this folder contains all the application files, but that may not be the case on other operating systems.

UpdateExePath

public override string? UpdateExePath { get; }

The path to the current Update.exe or similar on other operating systems.

AppContentDir

public override string? AppContentDir { get; }

The directory in which versioned application files are stored.

CurrentlyInstalledVersion

public override SemanticVersion? CurrentlyInstalledVersion { get; }

The currently installed version of the application, or null if the app is not installed.

PackagesDir

public override string? PackagesDir { get; }

The directory in which nupkg files are stored for this application.

IsPortable

public override bool IsPortable { get; }

A flag indicating if this is a portable build, and that the settings should be self-contained in the package. On Windows, this is true for portable builds, and false for non-portable builds which were installed by Setup.exe On OSX and Linux, this is always false, because settings and application files should be stored in the user's home directory.

Process

public override IProcessImpl Process { get; }

Provides an abstraction for dealing with the dotnet Process API. This is used to start processes and get information about the current process.

Channel

public override string? Channel { get; }

The release channel this package was built for.

AppUserModelId

public override string? AppUserModelId { get; }

The Application User Model ID for this app, used for taskbar grouping and toast notifications on Windows.

---

Generated from Velopack 1.1.1