Zero Install .NET API 2.20.0
ZeroInstall.Commands.Desktop.Self.Deploy Class Reference

Deploys Zero Install to a target directory and integrates it in the system. More...

Inheritance diagram for ZeroInstall.Commands.Desktop.Self.Deploy:
ZeroInstall.Commands.Desktop.Self.SelfSubCommand ZeroInstall.Commands.CliCommand ZeroInstall.Commands.ICliSubCommand ZeroInstall.Commands.ScopedOperation ZeroInstall.Services.ServiceProvider

Public Member Functions

 Deploy (ICommandHandler handler)
 
override ExitCode Execute ()
 Executes the commands specified by the command-line arguments. Must call Parse first! More...
 
- Public Member Functions inherited from ZeroInstall.Commands.CliCommand
virtual 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...
 

Static Public Attributes

const string Name = "deploy"
 

Properties

override string Description [get]
 
override string Usage [get]
 
override int AdditionalArgsMax [get]
 
- Properties inherited from ZeroInstall.Commands.Desktop.Self.SelfSubCommand
string ParentName [get]
 
- 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.
 
- Properties inherited from ZeroInstall.Commands.ICliSubCommand
string ParentName [get]
 The name of the CliMultiCommand this command is a sub-command of.
 

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...
 
- Protected Member Functions inherited from ZeroInstall.Commands.Desktop.Self.SelfSubCommand
 SelfSubCommand (ICommandHandler handler)
 
- 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.
 
- Static Protected Member Functions inherited from ZeroInstall.Commands.Desktop.Self.SelfSubCommand
static ? string FindExistingInstance (bool machineWide)
 Tries to find an existing instance of Zero Install deployed on this system. 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...
 
- Protected Attributes inherited from ZeroInstall.Commands.CliCommand
readonly List< string > AdditionalArgs = new()
 Feeds to add, terms to search for, etc.
 
- 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

Deploys Zero Install to a target directory and integrates it in the system.

Member Function Documentation

◆ Execute()

override ExitCode ZeroInstall.Commands.Desktop.Self.Deploy.Execute ( )
inlinevirtual

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

Returns
The exit status code to end the process with.
Exceptions
OperationCanceledExceptionThe user canceled the task.
OptionExceptionThe number of arguments passed in on the command-line is incorrect.
WebExceptionA file could not be downloaded from the internet.
NotSupportedExceptionA file format, protocol, etc. is unknown or not supported.
IOExceptionA downloaded file could not be written to the disk or extracted or an external application or file required by the solver could not be accessed.
UnauthorizedAccessExceptionAn operation failed due to insufficient rights.
InvalidDataExceptionA problem occurred while deserializing an XML file.
SignatureExceptionThe signature data could not be handled for some reason.
FormatExceptionAn URI, local path, version number, etc. is invalid.
DigestMismatchExceptionAn Implementation's Archives don't match the associated ManifestDigest.
SolverExceptionThe ISolver was unable to provide Selections that fulfill the Requirements.
ImplementationNotFoundExceptionOne of the ImplementationBases is not cached yet.
ExecutorExceptionThe IExecutor was unable to process the Selections.

When inheriting this method is usually replaced.

Implements ZeroInstall.Commands.CliCommand.


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