IVelopackLocator interface

Namespace: Velopack.Locators

An interface describing where Velopack can find key folders and files.

public interface IVelopackLocator

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
PackagesDir	The directory in which nupkg files are stored for this application.
AppContentDir	The directory in which versioned application files are stored.
AppTempDir	The temporary directory for this application.
UpdateExePath	The path to the current Update.exe or similar on other operating systems.
CurrentlyInstalledVersion	The currently installed version of the application, or null if the app is not installed.
ThisExeRelativePath	The path from AppContentDir to this executable.
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.
Log	The logging interface to use for Velopack diagnostic messages.
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

AppId

string? AppId { get; }

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

RootAppDir

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.

PackagesDir

string? PackagesDir { get; }

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

AppContentDir

string? AppContentDir { get; }

The directory in which versioned application files are stored.

AppTempDir

string? AppTempDir { get; }

The temporary directory for this application.

UpdateExePath

string? UpdateExePath { get; }

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

CurrentlyInstalledVersion

SemanticVersion? CurrentlyInstalledVersion { get; }

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

ThisExeRelativePath

string? ThisExeRelativePath { get; }

The path from AppContentDir to this executable.

Channel

string? Channel { get; }

The release channel this package was built for.

AppUserModelId

string? AppUserModelId { get; }

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

Log

IVelopackLogger Log { get; }

The logging interface to use for Velopack diagnostic messages.

IsPortable

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

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.

Methods

Method	Summary
AddLogger	Add a logger to the list of loggers. This will be used to log messages from Velopack.
GetLocalPackages	Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects.
GetLatestLocalFullPackage	Finds latest .nupkg file in the PackagesDir or null if not found.
GetOrCreateStagedUserId	Unique identifier for this user which is used to calculate whether this user is eligible for

AddLogger(logger)

void AddLogger(IVelopackLogger logger)

Add a logger to the list of loggers. This will be used to log messages from Velopack.

Parameters

Name	Type	Description
logger	IVelopackLogger

GetLocalPackages()

List<VelopackAsset> GetLocalPackages()

Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects.

Returns List<VelopackAsset>

GetLatestLocalFullPackage()

VelopackAsset? GetLatestLocalFullPackage()

Finds latest .nupkg file in the PackagesDir or null if not found.

Returns VelopackAsset

GetOrCreateStagedUserId()

Guid? GetOrCreateStagedUserId()

Unique identifier for this user which is used to calculate whether this user is eligible for staged roll outs.

Returns Guid?

---

Generated from Velopack 1.1.1