Zero Install .NET API 2.20.0
ZeroInstall.Commands.Desktop.AppCommand Class Referenceabstract

Common base class for commands that manage an AppList. More...

Inheritance diagram for ZeroInstall.Commands.Desktop.AppCommand:
ZeroInstall.Commands.Desktop.IntegrationCommand ZeroInstall.Commands.CliCommand ZeroInstall.Commands.ScopedOperation ZeroInstall.Services.ServiceProvider ZeroInstall.Commands.Desktop.AddAlias ZeroInstall.Commands.Desktop.AddApp ZeroInstall.Commands.Desktop.IntegrateApp ZeroInstall.Commands.Desktop.RemoveApp

Public Member Functions

override ExitCode Execute ()
 Executes the commands specified by the command-line arguments. Must call Parse first! More...
 
- Public Member Functions inherited from ZeroInstall.Commands.Desktop.IntegrationCommand
override void Parse (IEnumerable< string > args)
 Parses command-line arguments and stores the result in the command. More...
 
- Public Member Functions inherited from ZeroInstall.Commands.ScopedOperation
FeedUri GetCanonicalUri (string uri)
 Converts an interface or feed URI to its canonical representation. More...
 
- Public Member Functions inherited from ZeroInstall.Services.ServiceProvider
 ServiceProvider (ITaskHandler handler)
 Creates a new service provider. More...
 

Protected Member Functions

 AppCommand (ICommandHandler handler)
 
abstract ExitCode ExecuteHelper ()
 Template method that performs the actual operation. More...
 
void CreateAlias (AppEntry appEntry, string aliasName, string? command=null)
 Creates a new alias. More...
 
- Protected Member Functions inherited from ZeroInstall.Commands.Desktop.IntegrationCommand
 IntegrationCommand (ICommandHandler handler)
 
void CheckInstallBase ()
 Checks the current Locations.InstallBase to determine whether it is suitable for operations that persist it. More...
 
virtual AppEntry GetAppEntry (IIntegrationManager integrationManager, ref FeedUri interfaceUri)
 Finds an existing AppEntry or creates a new one for a specific interface URI. More...
 
- Protected Member Functions inherited from ZeroInstall.Commands.CliCommand
 CliCommand (ICommandHandler handler)
 Creates a new command. More...
 
void FetchAll (IEnumerable< Implementation > implementations)
 Downloads a set of Implementations to the Store in parallel. More...
 
ParallelQuery< T > AsParallel< T > (IEnumerable< T > elements)
 Prepares the elements for parallel processing while respecting Config.MaxParallelDownloads and ITaskHandler.CancellationToken.
 
- Protected Member Functions inherited from ZeroInstall.Commands.ScopedOperation
 ScopedOperation (ITaskHandler handler)
 Creates a new command base. More...
 
Catalog GetCatalog ()
 Returns a merged view of all Catalogs specified by the configuration files. More...
 
FeedFindByShortName (string shortName)
 Uses Catalog.FindByShortName to find a Feed matching a specific short name. More...
 
void SelfUpdateCheck ()
 Periodically checks Zero Install itself for updates in a background process.
 

Protected Attributes

FeedUri InterfaceUri = default!
 The interface for the application to perform the operation on.
 
- Protected Attributes inherited from ZeroInstall.Commands.Desktop.IntegrationCommand
bool NoDownload
 Do not download the application itself yet.
 
- Protected Attributes inherited from ZeroInstall.Commands.CliCommand
readonly List< string > AdditionalArgs = new()
 Feeds to add, terms to search for, etc.
 

Properties

override int AdditionalArgsMin [get]
 
override int AdditionalArgsMax [get]
 
CategoryIntegrationManager IntegrationManager = default! [get]
 Manages desktop integration operations.
 
- Properties inherited from ZeroInstall.Commands.Desktop.IntegrationCommand
bool MachineWide [getset]
 Apply the operation machine-wide instead of just for the current user.
 
- Properties inherited from ZeroInstall.Commands.CliCommand
string???? FullName [get]
 The full name of this command (including sub-commands) as used in command-line arguments in lower-case.
 
abstract string Description [get]
 A short description of what this command does.
 
abstract string Usage [get]
 The additional arguments to be displayed after the command name in the help text.
 
virtual int AdditionalArgsMin [get]
 The minimum number of AdditionalArgs allowed. Checked in Parse.
 
virtual int AdditionalArgsMax [get]
 The maximum number of AdditionalArgs allowed. Checked in Parse.
 
string HelpText [get]
 The help text describing the available command-line options and their effects.
 
new ICommandHandler Handler [get]
 A callback object used when the the user needs to be asked questions or informed about download and IO tasks.
 
- Properties inherited from ZeroInstall.Services.ServiceProvider
virtual ITaskHandler Handler [get]
 A callback object used when the the user needs to be asked questions or informed about download and IO tasks.
 
virtual Config Config [get]
 User settings controlling network behaviour, solving, etc.
 
virtual IImplementationStore ImplementationStore = ImplementationStores.Default() [getset]
 Describes an object that allows the storage and retrieval of Implementation directories.
 
virtual IOpenPgp OpenPgp = Store.Trust.OpenPgp.Verifying() [getset]
 Provides access to an encryption/signature system compatible with the OpenPGP standard.
 
virtual IFeedCache FeedCache [get]
 Provides access to a cache of Feeds that were downloaded via HTTP(S).
 
virtual ITrustManager TrustManager [get]
 Methods for verifying signatures and user trust.
 
virtual IFeedManager FeedManager [get]
 Allows configuration of the source used to request Feeds.
 
virtual ICatalogManager CatalogManager [get]
 Provides access to remote and local Catalogs. Handles downloading, signature verification and caching.
 
virtual IPackageManager PackageManager [get]
 An external package manager that can install PackageImplementations.
 
virtual ISelectionCandidateProvider SelectionCandidateProvider [get]
 Generates SelectionCandidates for the Solver to choose among.
 
virtual ISolver Solver [get]
 Chooses a set of Implementations to satisfy the requirements of a program and its user.
 
virtual IFetcher Fetcher [get]
 Used to download missing Implementations.
 
virtual IExecutor Executor [get]
 Executes a Selections document as a program using dependency injection.
 
virtual ISelectionsManager SelectionsManager [get]
 Provides methods for filtering Selections.
 

Additional Inherited Members

- Static Public Member Functions inherited from ZeroInstall.Commands.CliCommand
static CliCommand Create (string? commandName, ICommandHandler handler)
 Creates a new CliCommand based on a name. More...
 
static CliCommand CreateAndParse (IEnumerable< string > args, ICommandHandler handler)
 Parses command-line arguments, automatically creating an appropriate CliCommand. More...
 
static ? string GetCommandName (ref IEnumerable< string > args)
 Determines the command name specified in the command-line arguments. More...
 
- Static Protected Member Functions inherited from ZeroInstall.Commands.CliCommand
static string SupportedValues< T > (params T[] values)
 Generates a localized instruction string describing multiple selectable values. More...
 
static string SupportedValues< T > ()
 Generates a localized instruction string describing multiple selectable enum values. More...
 
- Static Protected Member Functions inherited from ZeroInstall.Commands.ScopedOperation
static void StartCommandBackground (string command, params string[] args)
 Starts executing a command in a background process. Returns immediately. More...
 
- Package Attributes inherited from ZeroInstall.Commands.CliCommand
readonly OptionSet Options = new()
 The command-line argument parser used to evaluate user input.
 
- Static Package Attributes inherited from ZeroInstall.Commands.CliCommand
static readonly string[] Names
 A list of command names (without alternatives) as used in command-line arguments in lower-case. More...
 

Detailed Description

Common base class for commands that manage an AppList.

Member Function Documentation

◆ CreateAlias()

void ZeroInstall.Commands.Desktop.AppCommand.CreateAlias ( AppEntry  appEntry,
string  aliasName,
string?  command = null 
)
inlineprotected

Creates a new alias.

Parameters
appEntryThe app entry to add the alias to.
aliasNameThe name of the alias to create.
commandA command within the interface the alias shall point to; can be null.

◆ Execute()

override ExitCode ZeroInstall.Commands.Desktop.AppCommand.Execute ( )
inlinevirtual

Executes the commands specified by the command-line arguments. Must call Parse first!

Implements ZeroInstall.Commands.CliCommand.

◆ ExecuteHelper()

abstract ExitCode ZeroInstall.Commands.Desktop.AppCommand.ExecuteHelper ( )
protectedpure virtual

Template method that performs the actual operation.

Returns
The exit status code to end the process with.

Implemented in ZeroInstall.Commands.Desktop.AddAlias, ZeroInstall.Commands.Desktop.AddApp, ZeroInstall.Commands.Desktop.IntegrateApp, and ZeroInstall.Commands.Desktop.RemoveApp.


The documentation for this class was generated from the following file: