Zero Install .NET API  2.21.0
ZeroInstall.Client.IZeroInstallClient Interface Reference

Client for invoking Zero Install commands from within other applications. More...

Inheritance diagram for ZeroInstall.Client.IZeroInstallClient:
ZeroInstall.Client.ZeroInstallClient

Public Member Functions

Task< SelectionsSelectAsync (Requirements requirements, bool refresh=false, bool offline=false)
 Selects a program and compatible versions of all of its dependencies. More...
 
Task< SelectionsDownloadAsync (Requirements requirements, bool refresh=false)
 Downloads a program and compatible versions of all of its dependencies. More...
 
void Run (Requirements requirements, bool refresh=false, bool needsTerminal=false, params string[] arguments)
 Runs a program via Zero Install. More...
 
Process RunWithProcess (Requirements requirements, bool refresh=false, bool needsTerminal=false, params string[] arguments)
 Runs a program via Zero Install and returns the process. More...
 
Task< ISet< string > > GetIntegrationAsync (FeedUri uri)
 Returns the desktop integration categories that are currently applied for a specific feed. More...
 
Task IntegrateAsync (FeedUri uri, IEnumerable< string >? add=null, IEnumerable< string >? remove=null)
 Adds an application to the application list (if missing) and integrates it into the desktop environment. More...
 
Task RemoveAsync (FeedUri uri)
 Removes an application from the application list and undoes any desktop environment integration. More...
 
Task FetchAsync (Implementation implementation)
 Downloads a set of Implementations. More...
 

Detailed Description

Client for invoking Zero Install commands from within other applications.

Member Function Documentation

◆ DownloadAsync()

Task<Selections> ZeroInstall.Client.IZeroInstallClient.DownloadAsync ( Requirements  requirements,
bool  refresh = false 
)

Downloads a program and compatible versions of all of its dependencies.

Parameters
requirementsThe requirements describing the program.
refreshFetch fresh copies of all used feeds.
Returns
The downloaded implementations.
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ FetchAsync()

Task ZeroInstall.Client.IZeroInstallClient.FetchAsync ( Implementation  implementation)

Downloads a set of Implementations.

Parameters
implementationThe implementations to download.
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ GetIntegrationAsync()

Task<ISet<string> > ZeroInstall.Client.IZeroInstallClient.GetIntegrationAsync ( FeedUri  uri)

Returns the desktop integration categories that are currently applied for a specific feed.

Parameters
uriThe feed URI of the application.
Returns
The access point categories (e.g., capability-registration, menu-entry, desktop-icon).
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ IntegrateAsync()

Task ZeroInstall.Client.IZeroInstallClient.IntegrateAsync ( FeedUri  uri,
IEnumerable< string >?  add = null,
IEnumerable< string >?  remove = null 
)

Adds an application to the application list (if missing) and integrates it into the desktop environment.

Parameters
uriThe feed URI of the application.
addThe access point categories to add (e.g., capability-registration, menu-entry, desktop-icon).
removeThe access point categories to remove (e.g., capability-registration, menu-entry, desktop-icon).
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ RemoveAsync()

Task ZeroInstall.Client.IZeroInstallClient.RemoveAsync ( FeedUri  uri)

Removes an application from the application list and undoes any desktop environment integration.

Parameters
uriThe feed URI of the application.
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ Run()

void ZeroInstall.Client.IZeroInstallClient.Run ( Requirements  requirements,
bool  refresh = false,
bool  needsTerminal = false,
params string[]  arguments 
)

Runs a program via Zero Install.

Parameters
requirementsThe requirements describing the program.
refreshFetch fresh copies of all used feeds.
needsTerminalIndicates that the program requires a terminal in order to run.
argumentsAdditional arguments to pass to the program.
Exceptions
IOExceptionThe external process could not be launched.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ RunWithProcess()

Process ZeroInstall.Client.IZeroInstallClient.RunWithProcess ( Requirements  requirements,
bool  refresh = false,
bool  needsTerminal = false,
params string[]  arguments 
)

Runs a program via Zero Install and returns the process.

Parameters
requirementsThe requirements describing the program.
refreshFetch fresh copies of all used feeds.
needsTerminalIndicates that the program requires a terminal in order to run.
argumentsAdditional arguments to pass to the program.
Returns
The newly launched process.
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.

◆ SelectAsync()

Task<Selections> ZeroInstall.Client.IZeroInstallClient.SelectAsync ( Requirements  requirements,
bool  refresh = false,
bool  offline = false 
)

Selects a program and compatible versions of all of its dependencies.

Parameters
requirementsThe requirements describing the program.
refreshFetch fresh copies of all used feeds.
offlineDo not refresh feeds even if they are out-of-date and don't select newer versions of programs for downloading even if they are already known.
Returns
The selected implementations.
Exceptions
IOExceptionThe external process could not be launched.
InvalidOperationExceptionThe external process returned a non-zero exit code.

Implemented in ZeroInstall.Client.ZeroInstallClient.


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