Zero Install .NET API 2.20.0
ZeroInstall.Commands.ScopedOperation Class Reference

Common base class for Zero Install operations that require scoped dependency resolution. More...

Inheritance diagram for ZeroInstall.Commands.ScopedOperation:
ZeroInstall.Services.ServiceProvider ZeroInstall.Commands.CliCommand ZeroInstall.Commands.Basic.AddRemoveFeedCommand ZeroInstall.Commands.Basic.Configure ZeroInstall.Commands.Basic.DefaultCommand ZeroInstall.Commands.Basic.Digest ZeroInstall.Commands.Basic.ExportHelp ZeroInstall.Commands.Basic.Fetch ZeroInstall.Commands.Basic.Import ZeroInstall.Commands.Basic.List ZeroInstall.Commands.Basic.ListFeeds ZeroInstall.Commands.Basic.Search ZeroInstall.Commands.Basic.Selection ZeroInstall.Commands.Basic.StoreMan.StoreSubCommand ZeroInstall.Commands.CliMultiCommand ZeroInstall.Commands.Desktop.Central ZeroInstall.Commands.Desktop.IntegrationCommand ZeroInstall.Commands.Desktop.Self.SelfSubCommand

Public Member Functions

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

 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

static void StartCommandBackground (string command, params string[] args)
 Starts executing a command in a background process. Returns immediately. More...
 

Additional Inherited Members

- 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.
 

Detailed Description

Common base class for Zero Install operations that require scoped dependency resolution.

Constructor & Destructor Documentation

◆ ScopedOperation()

ZeroInstall.Commands.ScopedOperation.ScopedOperation ( ITaskHandler  handler)
inlineprotected

Creates a new command base.

Parameters
handlerA callback object used when the the user needs to be asked questions or informed about download and IO tasks.

Member Function Documentation

◆ FindByShortName()

Feed? ZeroInstall.Commands.ScopedOperation.FindByShortName ( string  shortName)
inlineprotected

Uses Catalog.FindByShortName to find a Feed matching a specific short name.

Parameters
shortNameThe short name to look for. Must match either Feed.Name or EntryPoint.BinaryName of Command.NameRun.
Returns
The first matching Feed; null if no match was found.

Handles caching based on FeedManager.Refresh flag.

◆ GetCanonicalUri()

FeedUri ZeroInstall.Commands.ScopedOperation.GetCanonicalUri ( string  uri)
inline

Converts an interface or feed URI to its canonical representation.

Exceptions
UriFormatExceptionuri is an invalid interface URI.

◆ GetCatalog()

Catalog ZeroInstall.Commands.ScopedOperation.GetCatalog ( )
inlineprotected

Returns a merged view of all Catalogs specified by the configuration files.

Handles caching based on FeedManager.Refresh flag.

Exceptions
WebExceptionAttempted to download catalog and failed.

◆ StartCommandBackground()

static void ZeroInstall.Commands.ScopedOperation.StartCommandBackground ( string  command,
params string[]  args 
)
inlinestaticprotected

Starts executing a command in a background process. Returns immediately.

Parameters
commandThe name of the command to execute.
argsAdditional arguments to pass to the command.

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