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

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

Inheritance diagram for ZeroInstall.Commands.CliCommandHandler:
NanoByte::Common::Tasks::AnsiCliTaskHandler ZeroInstall.Commands.ICommandHandler NanoByte::Common::Tasks::CliTaskHandler NanoByte::Common::Tasks::ITaskHandler NanoByte::Common::Tasks::TaskHandlerBase NanoByte::Common::Tasks::ITaskHandler

Public Member Functions

void DisableUI ()
 Disables any persistent UI elements that were created but still leaves them visible. More...
 
void CloseUI ()
 Closes any persistent UI elements that were created. More...
 
void ShowSelections (Selections selections, IFeedManager feedManager)
 Shows the Selections made by the solver to the user. Returns immediately. May be ignored by some implementations. More...
 
void CustomizeSelections (Func< Selections > solveCallback)
 Allows the user to customize the interface preferences and rerun the solver if desired. Returns once the user is finished. More...
 
void ShowIntegrateApp (IntegrationState state)
 Displays application integration options to the user. Returns once the user is finished. More...
 
void ManageStore (IImplementationStore implementationStore, IFeedCache feedCache)
 Displays a user interface for managing IImplementationStores. Returns once the user is finished. More...
 
- Public Member Functions inherited from NanoByte::Common::Tasks::AnsiCliTaskHandler
override void RunTask (ITask task)
 
override void Dispose ()
 
override void Output (string title, string message)
 
override void Output (string title, IEnumerable< T > data)
 
override void Output (string title, NamedCollection< T > data)
 
- Public Member Functions inherited from NanoByte::Common::Tasks::CliTaskHandler
override void Dispose ()
 
override void RunTask (ITask task)
 
override void Output (string title, string message)
 
override void Error (Exception exception)
 
- Public Member Functions inherited from NanoByte::Common::Tasks::TaskHandlerBase
bool Ask (string question, bool? defaultAnswer=null, string? alternateMessage=null)
 

Properties

bool IsGui [get]
 Always returns false.
 
bool Background [getset]
 Always returns false.
 
- Properties inherited from NanoByte::Common::Tasks::AnsiCliTaskHandler
override? ICredentialProvider CredentialProvider
 
- Properties inherited from NanoByte::Common::Tasks::CliTaskHandler
override? ICredentialProvider CredentialProvider
 
override bool IsInteractive
 
- Properties inherited from NanoByte::Common::Tasks::TaskHandlerBase
CancellationTokenSource CancellationTokenSource
 
CancellationToken CancellationToken
 
virtual ? ICredentialProvider CredentialProvider
 
Verbosity Verbosity
 
virtual bool IsInteractive
 
- Properties inherited from NanoByte::Common::Tasks::ITaskHandler
CancellationToken CancellationToken
 
ICredentialProvider? CredentialProvider
 
Verbosity Verbosity
 
- Properties inherited from ZeroInstall.Commands.ICommandHandler
bool IsGui [get]
 Indicates whether this handler is a GUI.
 
bool Background [getset]
 Hides the GUI and uses something like a tray icon instead. Has no effect when IsGui is false.
 

Additional Inherited Members

- Protected Member Functions inherited from NanoByte::Common::Tasks::AnsiCliTaskHandler
override void LogHandler (LogSeverity severity, string message)
 
override bool AskInteractive (string question, bool defaultAnswer)
 
- Protected Member Functions inherited from NanoByte::Common::Tasks::CliTaskHandler
override bool AskInteractive (string question, bool defaultAnswer)
 

Detailed Description

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

Member Function Documentation

◆ CloseUI()

void ZeroInstall.Commands.CliCommandHandler.CloseUI ( )
inline

Closes any persistent UI elements that were created.

Implements ZeroInstall.Commands.ICommandHandler.

◆ CustomizeSelections()

void ZeroInstall.Commands.CliCommandHandler.CustomizeSelections ( Func< Selections solveCallback)

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

Implements ZeroInstall.Commands.ICommandHandler.

◆ DisableUI()

void ZeroInstall.Commands.CliCommandHandler.DisableUI ( )
inline

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

Implements ZeroInstall.Commands.ICommandHandler.

◆ ManageStore()

void ZeroInstall.Commands.CliCommandHandler.ManageStore ( IImplementationStore  implementationStore,
IFeedCache  feedCache 
)

Displays a user interface for managing IImplementationStores. Returns once the user is finished.

Implements ZeroInstall.Commands.ICommandHandler.

◆ ShowIntegrateApp()

void ZeroInstall.Commands.CliCommandHandler.ShowIntegrateApp ( IntegrationState  state)

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

Implements ZeroInstall.Commands.ICommandHandler.

◆ ShowSelections()

void ZeroInstall.Commands.CliCommandHandler.ShowSelections ( Selections  selections,
IFeedManager  feedManager 
)
inline

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

Implements ZeroInstall.Commands.ICommandHandler.


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