Skip to content

client.md

Latest commit

 

History

History
51 lines (36 loc) · 1.8 KB

client.md

File metadata and controls

51 lines (36 loc) · 1.8 KB
Raw
uid client-library

Client library

The xref:ZeroInstall.Client namespace allows you to invoke Zero Install commands from within other applications.

Use xref:ZeroInstall.Client.ZeroInstallClient.Detect to automatically discover the locations of the 0install and/or 0install-win executables. This gives you an instance of xref:ZeroInstall.Client.IZeroInstallClient, which enables easy programmatic access to a subset of the xref:command-line-interface.

Samples

Detect 0install location and the feed URI used to launch the app:

var zeroInstall = ZeroInstallClient.Detect;
var feedUri = ZeroInstallEnvironment.FeedUri ?? new FeedUri("https://example.com/your-feed.xml");

Download updates if available:

if (await zeroInstall.UpdateAsync(feedUri))
    NotifyUpdateAvailable();

Restart the app to run the latest version:

zeroInstall.Run(feedUri);
Environment.Exit(0);

Toggle the app's auto start desktop integration:

bool isAutoStartEnabled = zeroInstall.GetIntegration(feedUri).Contains(IntegrationCategories.AutoStart);
if (isAutoStartEnabled)
    await zeroInstall.IntegrateAsync(feedUri, remove: new[] {IntegrationCategories.AutoStart});
else
    await zeroInstall.IntegrateAsync(feedUri, add: new[] {IntegrationCategories.AutoStart});

Error handling

The client library maps 0install's exit codes to exceptions. Your code should be ready to catch:

  • xref:System.IO.IOException: 0install could not be launched or there was a problem accessing the filesystem.
  • xref:System.Net.WebException: There was a problem downloading a file.
  • xref:System.OperationCanceledException: The user canceled the operation.
  • xref:NanoByte.Common.ExitCodeException: Any other kind of error.