Show / Hide Table of Contents

Class ApplicationMaintenanceCommand

Represents application maintenance command.

Inheritance
object
Symbol
IdentifierSymbol
Command
ApplicationMaintenanceCommand
Implements
ICompletionSource
IEnumerable<Symbol>
IEnumerable
Inherited Members
Command.AddArgument(Argument)
Command.AddCommand(Command)
Command.AddOption(Option)
Command.AddGlobalOption(Option)
Command.Add(Option)
Command.Add(Argument)
Command.Add(Command)
Command.AddValidator(ValidateSymbolResult<CommandResult>)
Command.GetEnumerator()
Command.GetCompletions(CompletionContext)
Command.Children
Command.Arguments
Command.Options
Command.Subcommands
Command.TreatUnmatchedTokensAsErrors
Command.Handler
IdentifierSymbol.AddAlias(string)
IdentifierSymbol.HasAlias(string)
IdentifierSymbol.Aliases
IdentifierSymbol.Name
Symbol.GetCompletions()
Symbol.ToString()
Symbol.Description
Symbol.IsHidden
Symbol.Parents
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
Namespace: DotNext.Maintenance.CommandLine
Assembly: DotNext.MaintenanceServices.dll
Syntax
public sealed class ApplicationMaintenanceCommand : Command, ICompletionSource, IEnumerable<Symbol>, IEnumerable
Remarks

All registered singleton services of this type in DI container will be automatically discovered by CommandLineMaintenanceInterfaceHost.

Constructors

| Edit this page View Source

ApplicationMaintenanceCommand(string, string?)

Initializes a new maintenance command.

Declaration
public ApplicationMaintenanceCommand(string name, string? description = null)
Parameters
Type Name Description
string name

The name of the command.

string description

The description of the command.

Methods

| Edit this page View Source

Create(IApplicationStatusProvider)

Creates a command that can be used to execute members of IApplicationStatusProvider.

Declaration
public static ApplicationMaintenanceCommand Create(IApplicationStatusProvider provider)
Parameters
Type Name Description
IApplicationStatusProvider provider

The status provider.

Returns
Type Description
ApplicationMaintenanceCommand

A new command.

Exceptions
Type Condition
ArgumentNullException

provider is null.

| Edit this page View Source

EnterInteractiveModeCommand()

Creates a command that allows to enter interactive mode.

Declaration
public static ApplicationMaintenanceCommand EnterInteractiveModeCommand()
Returns
Type Description
ApplicationMaintenanceCommand

A new command.

| Edit this page View Source

GCCommand()

Creates a command that allows to force Garbage Collection.

Declaration
public static ApplicationMaintenanceCommand GCCommand()
Returns
Type Description
ApplicationMaintenanceCommand

A new command.

| Edit this page View Source

GetDefaultCommands()

Gets a collection of default commands.

Declaration
public static IEnumerable<ApplicationMaintenanceCommand> GetDefaultCommands()
Returns
Type Description
IEnumerable<ApplicationMaintenanceCommand>

A collection of default commands.

See Also
GCCommand()
EnterInteractiveModeCommand()
LeaveInteractiveModeCommand()
| Edit this page View Source

LeaveInteractiveModeCommand()

Creates a command that allows to leave interactive mode.

Declaration
public static ApplicationMaintenanceCommand LeaveInteractiveModeCommand()
Returns
Type Description
ApplicationMaintenanceCommand

A new command.

Events

| Edit this page View Source

Authorization

Allows to attach custom authorization rules for this command.

Declaration
public event AuthorizationCallback Authorization
Event Type
Type Description
AuthorizationCallback

Implements

ICompletionSource
IEnumerable<T>
IEnumerable

Extension Methods

BasicExtensions.As<T>(T)
BasicExtensions.GetUserData<T>(T)
BasicExtensions.IsBetween<T, TLowerBound, TUpperBound>(T, TLowerBound, TUpperBound)
BasicExtensions.IsOneOf<T>(T, ReadOnlySpan<T>)
ExpressionBuilder.Const<T>(T)
AsyncLockAcquisition.AcquireLockAsync<T>(T, CancellationToken)
AsyncLockAcquisition.AcquireLockAsync<T>(T, TimeSpan, CancellationToken)
AsyncLockAcquisition.AcquireReadLockAsync<T>(T, CancellationToken)
AsyncLockAcquisition.AcquireReadLockAsync<T>(T, TimeSpan, CancellationToken)
AsyncLockAcquisition.AcquireWriteLockAsync<T>(T, bool, CancellationToken)
AsyncLockAcquisition.AcquireWriteLockAsync<T>(T, bool, TimeSpan, CancellationToken)
AsyncLockAcquisition.AcquireWriteLockAsync<T>(T, CancellationToken)
AsyncLockAcquisition.AcquireWriteLockAsync<T>(T, TimeSpan, CancellationToken)
LockAcquisition.AcquireReadLock<T>(T)
LockAcquisition.AcquireReadLock<T>(T, TimeSpan)
LockAcquisition.AcquireUpgradeableReadLock<T>(T)
LockAcquisition.AcquireUpgradeableReadLock<T>(T, TimeSpan)
LockAcquisition.AcquireWriteLock<T>(T)
LockAcquisition.AcquireWriteLock<T>(T, TimeSpan)
Collection.Append<T>(IEnumerable<T>, params T[])
Collection.Copy<T>(IEnumerable<T>, int, MemoryAllocator<T>?)
Collection.ElementAt<T>(IEnumerable<T>, int, out T)
Collection.FirstOrNone<T>(IEnumerable<T>)
Collection.ForEachAsync<T>(IEnumerable<T>, Func<T, CancellationToken, ValueTask>, CancellationToken)
Collection.ForEach<T>(IEnumerable<T>, Action<T>)
Collection.LastOrNone<T>(IEnumerable<T>)
Collection.Prepend<T>(IEnumerable<T>, params T[])
Collection.SequenceHashCode<T>(IEnumerable<T>, bool)
Collection.SkipNulls<T>(IEnumerable<T?>)
Collection.ToAsyncEnumerable<T>(IEnumerable<T>)
Collection.ToString<T>(IEnumerable<T>, string, string)
Enumerator.GetAsyncEnumerator<T>(IEnumerable<T>, CancellationToken)
  • Edit this page
  • View Source
☀
☾
In this article
Back to top
Supported by the .NET Foundation
☀
☾