Class CliCommandHandler

Namespace

ZeroInstall.Commands

Assembly

0install.dll

Uses the stdin/stderr streams to allow users to interact with CliCommands.

[MustDisposeResource]
public sealed class CliCommandHandler : AnsiCliTaskHandler, ICommandHandler, ITaskHandler, IDisposable

Inheritance

object

TaskHandlerBase

CliTaskHandler

AnsiCliTaskHandler

CliCommandHandler

Implements

ICommandHandler

ITaskHandler

IDisposable

Inherited Members

AnsiCliTaskHandler.RunTask(ITask)

AnsiCliTaskHandler.Output(string, string)

AnsiCliTaskHandler.Output<T>(string, IEnumerable<T>)

AnsiCliTaskHandler.Output<T>(string, NamedCollection<T>)

AnsiCliTaskHandler.Error(Exception)

AnsiCliTaskHandler.Dispose()

TaskHandlerBase.Ask(string, bool?, string)

TaskHandlerBase.CancellationToken

TaskHandlerBase.Verbosity

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Background

Always returns false.

public bool Background { get; set; }

Property Value

bool

FeedUri

The URI of the Zero Install feed the current operation relates to.

public FeedUri? FeedUri { get; set; }

Property Value

FeedUri

Remarks

This can be used to apply application-specific visual branding.

IsGui

Always returns false.

public bool IsGui { get; }

Property Value

bool

Methods

CloseUI()

Closes any persistent UI elements that were created.

public void CloseUI()

CustomizeSelections(Func<Selections>)

Allows the user to customize the interface preferences and rerun the solver if desired. Returns once the user is finished.

public void CustomizeSelections(Func<Selections> solveCallback)

Parameters

solveCallback Func<Selections>

Called after interface preferences have been changed and the solver needs to be rerun.

DisableUI()

Disables any persistent UI elements that were created but still leaves them visible.

public void DisableUI()

ShowIntegrateApp(IntegrationState)

Displays application integration options to the user. Returns once the user is finished.

public void ShowIntegrateApp(IntegrationState state)

Parameters

state IntegrationState

A View-Model for modifying the current desktop integration state.

Remarks

The caller is responsible for applying changes.

Exceptions

OperationCanceledException

The user does not want any changes to be applied.

ShowSelections(Selections, IFeedManager)

Shows the Selections made by the solver to the user. Returns immediately. May be ignored by some implementations.

public void ShowSelections(Selections selections, IFeedManager feedManager)

Parameters

selections Selections

The Selections as provided by the solver.

feedManager IFeedManager

The feed manager used to retrieve feeds for additional information about implementations.