 | AppFacade Class |
This class is a facade to the properties and the state of an app.
It is initialized with the IConfiguration object, holding the apps properties
and the ID of the app.
Inheritance HierarchyNamespace: Mastersign.Bench
Assembly: BenchLib (in BenchLib.dll) Version: 0.22.0.0 (0.22.0.0)
SyntaxThe AppFacade type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AdornedExecutables |
An array with paths to executables, which must be adorned.
|
| AdornmentProxyBasePath |
Gets the base path of the directory containing the adornmend proxy scripts for the executables of this app.
|
| AppLibrary |
Gets the app library, this app is defined in.
|
| CanCheckInstallation |
Checks, whether the installation state of this app can be checked, or not.
|
| CanDeleteResource |
Checks, whether the app has cached resource.
|
| CanDownloadResource |
Checks, whether the app has a resource and the resource is not cached.
|
| CanInstall |
Checks, whether this app can be installed.
|
| CanReinstall |
Checks, whether this app can be reinstalled.
|
| CanTest |
Checks, whether this app can be tested or not.
|
| CanUninstall |
Checks, whether this app can be uninstalled.
|
| CanUpgrade |
Checks, whether this app can be upgraded to a more recent version.
|
| Category |
Gets the category, this app belongs to.
E.g. there are Required and Optional apps.
|
| Dependencies |
An array with app IDs which are necessary to be installed for this app to work.
|
| Dir |
The name of the target directory for this app.
The target directory is the directory where the app resources are installed.
|
| Docs |
Gets a dictionary with labels and URLs for help and documentation.
If an URL is relative, it is considered to be relative to the apps Dir.
|
| DownloadCookies |
Gets a dictionary with HTTP cookies for the download request.
|
| DownloadHeaders |
Gets a dictionary with HTTP header fields for the download request.
|
| Environment |
A dictionary with additional environment variables to setup, when this app is activated.
|
| Exe |
The relative path of the main executable file of the app, or null
in case the app has no executable (e.g. the app is just a group).
The path is relative to the target Dir of this app.
|
| ExeTest |
A flag to control whether the main executable of this app can be tested
by executing it with the ExeTestArguments and checking the exit code for 0.
|
| ExeTestArguments |
A command line argument string to pass to the main executable, when testing it for propery installation.
|
| Force |
Gets a value, which specifies if the app will be installed even if it is already installed.
|
| HasResource |
Checks, whether this app has a downloadable app resource, or not.
|
| ID |
Gets the ID of the app.
|
| InstalledVersion |
Gets or sets the version string, of the currently installed app.
|
| IsActivated |
Checks, whether this app is marked as activated by the user, or not.
|
| IsActive | Checks, whether this app is active. An app can be active, because it was marked by the user to be activated, or because it is required by Bench or it is a dependency for another app. An app is not active if it IsSuppressed. |
| IsAdornmentRequired |
Checks, whether execution adornment proxies are required for this app, or not.
|
| IsDeactivated |
Checks, whether this app is marked as deactivated by the user, or not.
|
| IsDependency |
Checks, whether this app is dependency of another app.
|
| IsInstalled |
Checks, whether this app is currently installed, or not.
|
| IsManagedPackage |
Checks, if this app is a packaged managed by some kind of package manager.
|
| IsManagedPackageFromRemoteRepo |
Checks, if this app is a package, downloaded from a remote repositry by some kind of package manager.
|
| IsPython2Package |
Checks if this app is a Python package which will be installed under Python 2;
|
| IsPython3Package |
Checks if this app is a Python package which will be installed under Python 3.
|
| IsRequired |
Checks, whether this app is required by the Bench system, or not.
|
| IsResourceCached | |
| IsSimpleVersion |
Checks, if the version of this app is a simple version number
like 1.12.5.000 or 3.4.
|
| IsSupported |
Checks, whether this app is supported in the current configuration on the current system.
An app is not supported, if the app is marked as Only64Bit and
the Bench configuration does not Allow64Bit
or the current system does not support 64Bit programs.
|
| IsSuppressed |
Checks, whether this app is suppressed.
An app can be suppressed, because it was marked by the user as deactivated.
And it can be suppressed, because it does only support 64Bit architecture
but the configuration or the system does not allow 64Bit programs.
|
| IsVersioned |
Checks, if this app has a specified version.
|
| IsVersionUpToDate |
Checks, whether the version of the app definition equals the version of the installed app.
|
| KnownProperties |
Returns all known properties.
|
| Label |
Gets the label of the app.
|
| Launcher |
The label for the apps launcher, or null if the app has no launcher.
|
| LauncherArguments |
An array with command line arguments to be sent to the LauncherExecutable
by the launcher.
The last entry in this array must be %* if additional arguments shell be passed
from the launcher to the executable. This is also necessary for drag-and-drop of files
onto the launcher to work.
|
| LauncherExecutable |
The path to the main executable, to be started by the apps launcher,
or null if the app has no launcher.
|
| LauncherIcon |
A path to an *.ico or *.exe file with the icon for the apps launcher,
or null if the app has no launcher.
|
| LauncherWorkingDir |
The path to a directory, to be the working directory, when starting the LauncherExecutable.
|
| License |
Gets the short name of the apps license.
|
| LicenseUrl |
Gets the absolute URL of the apps license document.
|
| LongStatus |
Returns a string with a virtually complete description of the apps overall state.
|
| MarkdownDocumentation |
Gets the documentation text of this app in Markdown syntax.
|
| Name |
Gets the name part of the apps ID.
|
| Namespace |
Gets the namespace part of the apps ID.
|
| NamespacePathSegment |
Gets a part for a filesystem path, which represents the namespace of this app.
|
| Only64Bit |
A flag to control whether this app can only be installed if 64Bit programs are supported.
|
| PackageName | |
| Path |
An array with relative or absolute paths,
which will be added to the environment variable PATH when this app is activated.
If a path is relative, it is relative to the target Dir of this app.
|
| PathSegment |
Gets a part for a filesystem path, which represents the id of this app.
|
| Register |
A flag to control if the Paths of this app will be added
to the environment variable PATH.
|
| RegistryKeys |
An array with registry paths relative to the HKCU (current user) hive,
which must be considered for registry isolation.
|
| ResourceArchiveName |
Gets the name of the apps archive resource, or null
in case the app has a file resource or no downloadable resource at all.
|
| ResourceArchivePath |
Gets the sub path inside of the resource archive, or null
in case the whole archive can be extracted or the app has no archive resource.
|
| ResourceArchiveTyp |
Gets the typ of the resource archive, or null if the app has no archive resource.
See AppArchiveTyps to compare or list the possible typs of an archive resource.
|
| ResourceFileName |
Gets the name of the apps file resource, or null
in case the app has an archive resource or no downloadable resource at all.
|
| Responsibilities |
An array of app IDs which depend on this app to be installed.
|
| SetupTestFile |
The relative path to a file, which existence can be used to check if the app is installed,
or null e.g. in case the app is a package managed by a package manager.
The path is relative to the target Dir of this app.
|
| ShortStatus |
Returns a short string, describing the overall state of the app.
|
| ShouldBeInstalled |
Checks, whether this app is active (activated or required) but not installed.
|
| ShouldBeRemoved |
Checks, whether this app is not activated or even deactivated but installed.
|
| StatusIcon |
Returns a code for an icon, describing the overall state of this app.
|
| Tags |
Gets the tags of the app.
|
| Typ | The typ of this app. See for AppTyps to compare and list the app typs. |
| UnknownProperties |
Returns all unknown properties.
|
| Url |
Gets the URL of the apps resource, or null if the app has no downloadable resource.
|
| Version |
Gets the version string of the app, or null if the app has no specified version.
|
| Website |
Gets the URL of the project or vendor website of this app, or null if no website was specified.
|
Methods| Name | Description | |
|---|---|---|
 | Deactivate |
Marks this app as deactivetd.
|
| DiscardCachedValues |
Clears cached values from the state of the app.
If the state of an app was possibly changed, this method has to be called,
to allow determining the new state from the file system and not just showing
the last cached state.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetCustomScript |
Gets a path to a custom script file for this app.
|
| GetExecutableProxy |
Gets the path to the adornment wrapper script for a given executable of this app.
|
| GetHashCode | (Inherited from Object.) |
| GetLauncherFile |
Gets a path to the launcher shortcut file.
|
| GetLauncherScriptFile |
Gets a path to the launcher script file.
|
| GetSetupResource |
Gets a path to a setup resource file or directory.
|
| GetType | (Inherited from Object.) |
| IsExecutableAdorned |
Checks, whether an executable of this app is marked as adorned, or not.
|
 | IsKnownProperty |
Checks whether a property name is known to the Bench system or not.
|
| LoadCachedValues |
Does some expensive checks for the app and caches the result for later requests.
These checks involve interaction with the file system.
|
| MatchSearchString |
Matches a number of search words against this app.
|
| MemberwiseClone | (Inherited from Object.) |
| ToString |
Returns a string, containing the apps typ and ID.
(Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
 | KnownPropertyKeys |
An array with all property keys, which are known by the Bench system.
|
| NS_SEPARATOR |
The namespace separator in an app ID.
|
See Also