IVelopackLocator Interface
Namespace: Velopack.Locators
Assembly: Velopack
Assembly Version: 0.0.1298+ed8600e
An interface describing where Velopack can find key folders and files.
[NullableContext(2)]
public interface IVelopackLocator
Attributes: NullableContextAttribute
Properties
| Name | Description |
|---|---|
| AppContentDir | The directory in which versioned application files are stored. |
| AppId | The unique application Id. This is used in various app paths. |
| AppTempDir | The temporary directory for this application. |
| Channel | The release channel this package was built for. |
| CurrentlyInstalledVersion | The currently installed version of the application, or null if the app is not installed. |
| IsPortable | 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. |
| Log | The logging interface to use for Velopack diagnostic messages. |
| PackagesDir | The directory in which nupkg files are stored for this application. |
| ProcessExePath | The process for which the Velopack Locator has been constructed. This should usually be the current process path. |
| ProcessId | The process ID for which the Velopack Locator has been constructed. This should usually be the current process ID. Setting this to zero will disable some features of Velopack (like the ability to wait for the process to exit before installing updates). |
| RootAppDir | 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. |
| ThisExeRelativePath | The path from AppContentDir to this executable. |
| UpdateExePath | The path to the current Update.exe or similar on other operating systems. |
Methods
| Name | Description |
|---|---|
| GetLatestLocalFullPackage() | Finds latest .nupkg file in the PackagesDir or null if not found. |
| GetLocalPackages() | Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. |
| GetOrCreateStagedUserId() | Unique identifier for this user which is used to calculate whether this user is eligible for staged roll outs. |
Documentation generated by MdDocs