UNPKG

nswag

Version:

The Swagger API toolchain for .NET, Web API and TypeScript.

632 lines (631 loc) 37.9 kB
<?xml version="1.0"?> <doc> <assembly> <name>NSwag.Commands</name> </assembly> <members> <member name="T:NSwag.Commands.CodeGeneratorCollection"> <summary>The command collection.</summary> </member> <member name="P:NSwag.Commands.CodeGeneratorCollection.OpenApiToTypeScriptClientCommand"> <summary>Gets or sets the SwaggerToTypeScriptClientCommand.</summary> </member> <member name="P:NSwag.Commands.CodeGeneratorCollection.OpenApiToCSharpClientCommand"> <summary>Gets or sets the SwaggerToCSharpClientCommand.</summary> </member> <member name="P:NSwag.Commands.CodeGeneratorCollection.OpenApiToCSharpControllerCommand"> <summary>Gets or sets the SwaggerToCSharpControllerCommand.</summary> </member> <member name="P:NSwag.Commands.CodeGeneratorCollection.Items"> <summary>Gets the items.</summary> </member> <member name="T:NSwag.Commands.CodeGeneration.OperationGenerationMode"> <summary>Specifies how the operation name and client classes/interfaces are generated.</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.MultipleClientsFromOperationId"> <summary>Multiple clients from the Swagger operation ID in the form '{controller}_{action}'.</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.MultipleClientsFromPathSegments"> <summary>From path segments (operation name = last segment, client name = second to last segment).</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.MultipleClientsFromFirstTagAndPathSegments"> <summary>From the first operation tag and path segments (operation name = last segment, client name = first operation tag).</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.MultipleClientsFromFirstTagAndOperationId"> <summary>From the first operation tag and operation ID (operation name = operation ID, client name = first operation tag).</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.SingleClientFromOperationId"> <summary>From the Swagger operation ID.</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.SingleClientFromPathSegments"> <summary>From path segments suffixed by HTTP operation name</summary> </member> <member name="F:NSwag.Commands.CodeGeneration.OperationGenerationMode.MultipleClientsFromFirstTagAndOperationName"> <summary>From the first operation tag and operation name (underscore separated from operation id)</summary> </member> <member name="T:NSwag.Commands.Generation.AspNetCore.AspNetCoreToOpenApiCommand"> <summary>The generator.</summary> </member> <member name="T:NSwag.Commands.Generation.AspNetCore.AspNetCoreToOpenApiGeneratorCommandEntryPoint"> <summary>In-process entry point for the aspnetcore2swagger command.</summary> </member> <member name="M:NSwag.Commands.Generation.AspNetCore.ProjectMetadata.TryReadingUsingGetProperties(System.Collections.Generic.List{System.String},System.String,System.Boolean)"> <summary> NET 8 and later support evaluating properties via CLI. https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-8#cli-based-project-evaluation </summary> </member> <member name="T:NSwag.Commands.Generation.FromDocumentCommand"> <summary>Reads a Swagger specification from JSON or an URL.</summary> </member> <member name="P:NSwag.Commands.Generation.FromDocumentCommand.Json"> <summary>Gets or sets the input Swagger specification.</summary> </member> <member name="P:NSwag.Commands.Generation.FromDocumentCommand.Url"> <summary>Gets or sets the input Swagger specification URL.</summary> </member> <member name="M:NSwag.Commands.Generation.FromDocumentCommand.RunAsync(NConsole.CommandLineProcessor,NConsole.IConsoleHost)"> <summary>Runs the asynchronous.</summary> <param name="processor">The processor.</param> <param name="host">The host.</param> <returns></returns> </member> <member name="M:NSwag.Commands.Generation.FromDocumentCommand.RunAsync"> <summary>Loads the Swagger spec.</summary> </member> <member name="E:NSwag.Commands.Generation.FromDocumentCommand.PropertyChanged"> <summary>Occurs when property changed.</summary> </member> <member name="M:NSwag.Commands.Generation.FromDocumentCommand.OnPropertyChanged(System.String)"> <summary>Called when property changed.</summary> </member> <member name="M:NSwag.Commands.InputOutputCommandBase.GetInputSwaggerDocument"> <exception cref="T:System.ArgumentException">The argument 'Input' was empty.</exception> </member> <member name="M:NSwag.Commands.InputOutputCommandBase.GetJsonSchemaAsync"> <exception cref="T:System.ArgumentException">The argument 'Input' was empty.</exception> </member> <member name="T:NSwag.Commands.Tooling.VersionCommand"> <summary>Prints the tool chain version.</summary> </member> <member name="M:NSwag.Commands.Tooling.VersionCommand.RunAsync(NConsole.CommandLineProcessor,NConsole.IConsoleHost)"> <summary>Runs the command.</summary> <param name="processor">The processor.</param> <param name="host">The host.</param> <returns>The output.</returns> </member> <member name="T:NSwag.Commands.NewLineBehavior"> <summary> Enumeratoin of new line behaviors. </summary> </member> <member name="F:NSwag.Commands.NewLineBehavior.Auto"> <summary> Automatic line ending based on the current OS. </summary> </member> <member name="F:NSwag.Commands.NewLineBehavior.CRLF"> <summary> CRLF. </summary> </member> <member name="F:NSwag.Commands.NewLineBehavior.LF"> <summary> LF. </summary> </member> <member name="T:NSwag.Commands.NSwagCommandProcessor"> <summary></summary> </member> <member name="M:NSwag.Commands.NSwagCommandProcessor.#ctor(NConsole.IConsoleHost)"> <summary>Initializes a new instance of the <see cref="T:NSwag.Commands.NSwagCommandProcessor" /> class.</summary> <param name="host">The host.</param> </member> <member name="M:NSwag.Commands.NSwagCommandProcessor.Process(System.String[])"> <summary>Processes the command line arguments.</summary> <param name="args">The arguments.</param> <returns>The result.</returns> </member> <member name="M:NSwag.Commands.NSwagCommandProcessor.ProcessAsync(System.String[])"> <summary>Processes the command line arguments.</summary> <param name="args">The arguments.</param> <returns>The result.</returns> </member> <member name="T:NSwag.Commands.NSwagDocument"> <summary>The NSwagDocument implementation.</summary> <seealso cref="T:NSwag.Commands.NSwagDocumentBase" /> </member> <member name="M:NSwag.Commands.NSwagDocument.#ctor"> <summary>Initializes a new instance of the <see cref="T:NSwag.Commands.NSwagDocument"/> class.</summary> </member> <member name="M:NSwag.Commands.NSwagDocument.Create"> <summary>Creates a new NSwagDocument.</summary> <returns>The document.</returns> </member> <member name="M:NSwag.Commands.NSwagDocument.LoadAsync(System.String)"> <summary>Loads an existing NSwagDocument.</summary> <param name="filePath">The file path.</param> <returns>The document.</returns> </member> <member name="M:NSwag.Commands.NSwagDocument.LoadWithTransformationsAsync(System.String,System.String)"> <summary>Loads an existing NSwagDocument with environment variable expansions and variables.</summary> <param name="filePath">The file path.</param> <param name="variables">The variables.</param> <returns>The document.</returns> </member> <member name="M:NSwag.Commands.NSwagDocument.ExecuteAsync"> <summary>Executes the document.</summary> <returns>The task.</returns> </member> <member name="M:NSwag.Commands.NSwagDocument.ExecuteCommandLineAsync(System.Boolean)"> <summary>Executes the document via command line.</summary> <param name="redirectOutput">Indicates whether to redirect the outputs.</param> <returns>The result.</returns> </member> <member name="M:NSwag.Commands.NSwagDocument.ConvertToAbsolutePath(System.String)"> <summary>Converts to absolute path.</summary> <param name="pathToConvert">The path to convert.</param> <returns>The absolute path.</returns> </member> <member name="M:NSwag.Commands.NSwagDocument.ConvertToRelativePath(System.String)"> <summary>Converts a path to an relative path.</summary> <param name="pathToConvert">The path to convert.</param> <returns>The relative path.</returns> </member> <member name="T:NSwag.Commands.NSwagDocumentBase"> <summary>The NSwagDocument base class.</summary> <seealso cref="T:System.ComponentModel.INotifyPropertyChanged" /> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.#ctor"> <summary>Initializes a new instance of the <see cref="T:NSwag.Commands.NSwagDocumentBase"/> class.</summary> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.ConvertToAbsolutePath(System.String)"> <summary>Converts a path to an absolute path.</summary> <param name="pathToConvert">The path to convert.</param> <returns>The absolute path.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.ConvertToRelativePath(System.String)"> <summary>Converts a path to an relative path.</summary> <param name="pathToConvert">The path to convert.</param> <returns>The relative path.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.ExecuteAsync"> <summary>Executes the current document.</summary> <returns>The result.</returns> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.Runtime"> <summary>Gets or sets the runtime where the document should be processed.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.DefaultVariables"> <summary>Gets or sets the default variables.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.SelectedSwaggerGeneratorRaw"> <summary>Gets or sets the selected swagger generator JSON.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.SwaggerGenerators"> <summary>Gets the swagger generators.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.CodeGenerators"> <summary>Gets the code generators.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.Path"> <summary>Gets or sets the path.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.Name"> <summary>Gets the name of the document.</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.IsDirty"> <summary>Gets a value indicating whether the document is dirty (has any changes).</summary> </member> <member name="P:NSwag.Commands.NSwagDocumentBase.SelectedSwaggerGenerator"> <summary>Gets the selected Swagger generator.</summary> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.Create``1"> <summary>Creates a new NSwagDocument.</summary> <typeparam name="TDocument">The type.</typeparam> <returns>The document.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.LoadAsync``1(System.String,System.String,System.Boolean)"> <summary>Loads an existing NSwagDocument.</summary> <typeparam name="TDocument">The type.</typeparam> <param name="filePath">The file path.</param> <param name="variables">The variables.</param> <param name="applyTransformations">Specifies whether to expand environment variables and convert variables.</param> <returns>The document.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.FromJson``1(System.String,System.String)"> <summary>Converts the document to JSON.</summary> <typeparam name="TDocument">The document type.</typeparam> <param name="filePath">The file path.</param> <param name="data">The JSON data.</param> <returns>The document.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.SaveAsync"> <summary>Saves the document.</summary> <returns>The task.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.ToJsonWithRelativePaths"> <summary>Converts the document to JSON with relative paths.</summary> <returns>The JSON data.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.ToJson"> <summary>Converts the document to JSON.</summary> <returns>The JSON data.</returns> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.GenerateSwaggerDocumentAsync"> <summary>Generates the <see cref="T:NSwag.OpenApiDocument"/> with the currently selected generator.</summary> <returns>The document.</returns> </member> <member name="E:NSwag.Commands.NSwagDocumentBase.PropertyChanged"> <summary>Occurs when a property value changes.</summary> </member> <member name="M:NSwag.Commands.NSwagDocumentBase.RaiseAllPropertiesChanged"> <summary>Raises all properties changed.</summary> </member> <member name="T:NSwag.Commands.OpenApiDocumentExecutionResult"> <summary>Stores the result of a <see cref="T:NSwag.OpenApiDocument"/> execution.</summary> </member> <member name="M:NSwag.Commands.OpenApiDocumentExecutionResult.#ctor(System.String,System.String,System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NSwag.Commands.NSwagDocumentBase"/> class.</summary> <param name="output">The command line output.</param> <param name="swaggerOutput">The Swagger JSON output.</param> <param name="isRedirectedOutput">Indicates whether the output is redirect.</param> </member> <member name="P:NSwag.Commands.OpenApiDocumentExecutionResult.Output"> <summary>Gets the command line output.</summary> </member> <member name="P:NSwag.Commands.OpenApiDocumentExecutionResult.SwaggerOutput"> <summary>Gets the Swagger JSON output.</summary> </member> <member name="P:NSwag.Commands.OpenApiDocumentExecutionResult.IsRedirectedOutput"> <summary>Gets a value indicating whether the output is redirect.</summary> </member> <member name="M:NSwag.Commands.OpenApiDocumentExecutionResult.AddGeneratorOutput(System.Type,System.String)"> <summary>Adds a generator output (e.g. code) to the result</summary> <param name="key">The type of the generator command.</param> <param name="output">The output string.</param> </member> <member name="M:NSwag.Commands.OpenApiDocumentExecutionResult.GetGeneratorOutput``1"> <summary>Gets a genrator output with a generator command type key.</summary> <typeparam name="T">The generator command type.</typeparam> <returns>The output.</returns> </member> <member name="T:NSwag.Commands.OpenApiGeneratorCollection"> <summary></summary> </member> <member name="P:NSwag.Commands.OpenApiGeneratorCollection.FromDocumentCommand"> <summary>Gets or sets the input to swagger command.</summary> </member> <member name="P:NSwag.Commands.OpenApiGeneratorCollection.JsonSchemaToOpenApiCommand"> <summary>Gets or sets the json schema to swagger command.</summary> </member> <member name="P:NSwag.Commands.OpenApiGeneratorCollection.AspNetCoreToOpenApiCommand"> <summary>Gets or sets the ASP.NET Core to swagger command.</summary> </member> <member name="P:NSwag.Commands.OpenApiGeneratorCollection.Items"> <summary>Gets the items.</summary> </member> <member name="M:NSwag.Commands.PathUtilities.ExpandFileWildcards(System.String)"> <summary>Expands the given wildcards (** or *) in the path.</summary> <param name="path">The file path with wildcards.</param> <returns>All expanded file paths.</returns> </member> <member name="M:NSwag.Commands.PathUtilities.ExpandFileWildcards(System.Collections.Generic.IEnumerable{System.String})"> <summary>Expands the given wildcards (** or *) in the paths.</summary> <param name="paths">The files path with wildcards.</param> <returns>All expanded file paths.</returns> </member> <member name="M:NSwag.Commands.PathUtilities.FindWildcardMatches(System.String,System.Collections.Generic.IEnumerable{System.String},System.Char)"> <summary>Finds the wildcard matches.</summary> <param name="selector">The selector.</param> <param name="items">The items.</param> <param name="delimiter">The delimiter.</param> <returns>The matches.</returns> </member> <member name="M:NSwag.Commands.PathUtilities.MakeAbsolutePath(System.String,System.String)"> <summary>Converts a relative path to an absolute path.</summary> <param name="relativePath">The relative path.</param> <param name="relativeTo">The current directory.</param> <returns>The absolute path.</returns> </member> <member name="M:NSwag.Commands.PathUtilities.MakeRelativePath(System.String,System.String)"> <summary>Converts an absolute path to a relative path if possible.</summary> <param name="absolutePath">The absolute path.</param> <param name="relativeTo">The current directory.</param> <returns>The relative path.</returns> <exception cref="T:System.ArgumentException">The path of the two files doesn't have any common base.</exception> </member> <member name="T:NSwag.Commands.Runtime"> <summary>Enumeration of .NET runtimes where a document can be processed.</summary> </member> <member name="F:NSwag.Commands.Runtime.Default"> <summary>Use default and do no checks.</summary> </member> <member name="F:NSwag.Commands.Runtime.WinX64"> <summary>Full .NET framework, x64.</summary> </member> <member name="F:NSwag.Commands.Runtime.WinX86"> <summary>Full .NET framework, x86.</summary> </member> <member name="F:NSwag.Commands.Runtime.Net80"> <summary>.NET 8 app.</summary> </member> <member name="F:NSwag.Commands.Runtime.Net90"> <summary>.NET 9 app.</summary> </member> <member name="F:NSwag.Commands.Runtime.Net100"> <summary>.NET 10 app.</summary> </member> <member name="F:NSwag.Commands.Runtime.Debug"> <summary>Execute in the same process.</summary> </member> <member name="T:NSwag.Commands.RuntimeUtilities"> <summary>Provides runtime utilities.</summary> </member> <member name="P:NSwag.Commands.RuntimeUtilities.CurrentRuntime"> <summary>Gets the current runtime.</summary> </member> <member name="T:NConsole.ArgumentAttribute"> <summary>Attribute to define a command line argument.</summary> </member> <member name="P:NConsole.ArgumentAttribute.Name"> <summary>Gets or sets the argument name.</summary> </member> <member name="P:NConsole.ArgumentAttribute.Description"> <summary>Gets or sets the argument description.</summary> </member> <member name="P:NConsole.ArgumentAttribute.Position"> <summary>Gets or sets the position of the unnamed argument.</summary> </member> <member name="P:NConsole.ArgumentAttribute.IsRequired"> <summary>Gets or sets a value indicating whether the argument is required (default: true).</summary> </member> <member name="P:NConsole.ArgumentAttribute.AcceptsCommandInput"> <summary>Gets or sets a value indicating whether the argument accepts an input from a previous command (default: false).</summary> </member> <member name="P:NConsole.ArgumentAttribute.ShowPrompt"> <summary>Gets or sets a value indicating whether to prompt the user for the value.</summary> </member> <member name="M:NConsole.ArgumentAttribute.GetValue(NConsole.IConsoleHost,System.String[],System.Reflection.PropertyInfo,NConsole.IConsoleCommand,System.Object,System.String@)"> <summary>Gets the argument value.</summary> <param name="consoleHost">The command line host.</param> <param name="args">The arguments.</param> <param name="property">The property.</param> <param name="command">The command.</param> <param name="input">The output from the previous command in the chain.</param> <param name="used">Indicates whether a value for the property was found in the given arguments.</param> <returns>The value.</returns> <exception cref="T:System.InvalidOperationException">Either the argument Name or Position can be set, but not both.</exception> <exception cref="T:System.InvalidOperationException">Either the argument Name or Position can be set, but not both.</exception> <exception cref="T:System.InvalidOperationException">The parameter has no default value.</exception> </member> <member name="T:NConsole.ArgumentAttributeBase"> <summary>The argument attribute base class.</summary> </member> <member name="M:NConsole.ArgumentAttributeBase.GetValue(NConsole.IConsoleHost,System.String[],System.Reflection.PropertyInfo,NConsole.IConsoleCommand,System.Object,System.String@)"> <summary>Gets the argument value.</summary> <param name="consoleHost">The command line host.</param> <param name="args">The arguments.</param> <param name="property">The property.</param> <param name="command"></param> <param name="input">The output from the previous command in the chain.</param> <returns>The value.</returns> </member> <member name="M:NConsole.ArgumentAttributeBase.ConvertToType(System.String,System.Type)"> <summary>Converts a string value to a specific type.</summary> <param name="value">The value.</param> <param name="type">The type.</param> <returns>The value.</returns> </member> <member name="T:NConsole.CommandAttribute"> <summary>Attribute to define a command class.</summary> </member> <member name="P:NConsole.CommandAttribute.Name"> <summary>Gets or sets the name.</summary> </member> <member name="P:NConsole.CommandAttribute.Description"> <summary>Gets or sets the description.</summary> </member> <member name="T:NConsole.UnusedArgumentException"> <summary>An provided argument is not used.</summary> </member> <member name="T:NConsole.CommandLineProcessor"> <summary>A command base command line processor.</summary> </member> <member name="M:NConsole.CommandLineProcessor.#ctor(NConsole.IConsoleHost,NConsole.IDependencyResolver,System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NConsole.CommandLineProcessor" /> class.</summary> <param name="consoleHost">The command line host.</param> <param name="dependencyResolver">The dependency resolver.</param> </member> <member name="P:NConsole.CommandLineProcessor.Commands"> <summary>Gets the list of registered commands.</summary> </member> <member name="M:NConsole.CommandLineProcessor.RegisterCommand``1(System.String)"> <summary>Adds a command.</summary> <typeparam name="TCommandLineCommand">The type of the command.</typeparam> <param name="name">The name of the command.</param> </member> <member name="M:NConsole.CommandLineProcessor.RegisterCommand``1"> <summary>Adds a command.</summary> <typeparam name="TCommandLineCommand">The type of the command.</typeparam> </member> <member name="M:NConsole.CommandLineProcessor.RegisterCommandsFromAssembly(System.Reflection.Assembly)"> <summary>Loads all commands from an assembly (command classes must have the CommandAttribute with a defined Name).</summary> <param name="assembly">The assembly.</param> </member> <member name="M:NConsole.CommandLineProcessor.RegisterCommand(System.Type)"> <summary>Adds a command.</summary> <param name="commandType">Type of the command.</param> <exception cref="T:System.InvalidOperationException">The command has already been added.</exception> <exception cref="T:System.InvalidOperationException">The command class is missing the CommandAttribute attribute.</exception> </member> <member name="M:NConsole.CommandLineProcessor.RegisterCommand(System.String,System.Type)"> <summary>Adds a command.</summary> <param name="name">The name of the command.</param> <param name="commandType">Type of the command.</param> <exception cref="T:System.InvalidOperationException">The command has already been added.</exception> </member> <member name="M:NConsole.CommandLineProcessor.ProcessAsync(System.String[],System.Object)"> <summary>Processes the command in the given command line arguments.</summary> <param name="args">The arguments.</param> <param name="input">The input for the first command.</param> <returns>The executed command.</returns> <exception cref="T:System.InvalidOperationException">The command could not be found.</exception> <exception cref="T:System.InvalidOperationException">No dependency resolver available to create a command without default constructor.</exception> </member> <member name="M:NConsole.CommandLineProcessor.TryLookupCommandType(System.String)"> <summary> Search for command type matching a command name. </summary> <param name="commandName">Name of the command to search for.</param> <returns>The matching command, otherwise NULL.</returns> </member> <member name="M:NConsole.CommandLineProcessor.ProcessSingleAsync(System.String[],System.Object)"> <summary>Processes the command in the given command line arguments.</summary> <param name="args">The arguments.</param> <param name="input">The input for the command.</param> <returns>The executed command.</returns> <exception cref="T:System.InvalidOperationException">The command could not be found.</exception> <exception cref="T:System.InvalidOperationException">No dependency resolver available to create a command without default constructor.</exception> </member> <member name="M:NConsole.CommandLineProcessor.Process(System.String[],System.Object)"> <summary>Processes the command in the given command line arguments.</summary> <param name="args">The arguments.</param> <param name="input">The output from the previous command.</param> <returns>The exeucuted command.</returns> <exception cref="T:System.InvalidOperationException">The command could not be found.</exception> <exception cref="T:System.InvalidOperationException">No dependency resolver available to create a command without default constructor.</exception> </member> <member name="M:NConsole.CommandLineProcessor.ProcessWithExceptionHandling(System.String[],System.Object)"> <summary>Processes the command in the given command line arguments.</summary> <param name="args">The arguments.</param> <param name="input">The output from the previous command.</param> <returns>The exeucuted command.</returns> </member> <member name="M:NConsole.CommandLineProcessor.ReadCommandNameInteractive"> <summary> Read the command name using console host if it was not provided by call. </summary> <returns>Command name input by user</returns> </member> <member name="M:NConsole.CommandLineProcessor.GetCommandNameAndArguments(System.String[],System.String@,System.Collections.Generic.IEnumerable{System.String}@)"> <summary>Gets the name of the command to execute.</summary> <param name="args">The arguments.</param> </member> <member name="M:NConsole.CommandLineProcessor.CreateCommand(System.Type)"> <exception cref="T:System.InvalidOperationException">No dependency resolver available to create a command without default constructor.</exception> </member> <member name="T:NConsole.CommandResult"> <summary>A command result.</summary> </member> <member name="P:NConsole.CommandResult.Command"> <summary>Gets or sets the command.</summary> </member> <member name="P:NConsole.CommandResult.Output"> <summary>Gets or sets the command output.</summary> </member> <member name="T:NConsole.ConsoleHost"> <summary>A command line host implementation which uses System.Console.</summary> </member> <member name="M:NConsole.ConsoleHost.#ctor"> <summary>Initializes a new instance of the <see cref="T:NConsole.ConsoleHost"/> class.</summary> </member> <member name="M:NConsole.ConsoleHost.#ctor(System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NConsole.ConsoleHost"/> class.</summary> <param name="interactiveMode">Specifies whether interactive mode is enabled.</param> </member> <member name="P:NConsole.ConsoleHost.InteractiveMode"> <summary>Gets or sets a value indicating whether interactive mode is enabled (i.e. ReadValue() is allowed).</summary> </member> <member name="M:NConsole.ConsoleHost.WriteMessage(System.String)"> <summary>Writes a message to the console.</summary> <param name="message">The message.</param> </member> <member name="M:NConsole.ConsoleHost.WriteError(System.String)"> <summary>Writes an error message to the console.</summary> <param name="message">The message.</param> </member> <member name="M:NConsole.ConsoleHost.ReadValue(System.String)"> <summary>Reads a value from the console.</summary> <param name="message">The message.</param> <returns>The value.</returns> <exception cref="T:System.InvalidOperationException">Cannot read value from command line because interactive mode is disabled.</exception> </member> <member name="T:NConsole.HelpCommand"> <summary>The help command to show the availble list of commands.</summary> </member> <member name="P:NConsole.HelpCommand.Command"> <summary>Gets the command to print infos for (by default not set => prints all commands).</summary> </member> <member name="P:NConsole.HelpCommand.Usage"> <summary> Usage line of help command. </summary> </member> <member name="M:NConsole.HelpCommand.RunAsync(NConsole.CommandLineProcessor,NConsole.IConsoleHost)"> <summary>Runs the command.</summary> <param name="processor">The processor.</param> <param name="host">The host.</param> <returns>The input object for the next command.</returns> </member> <member name="M:NConsole.HelpCommand.PromptInteractiveOnly(NConsole.IConsoleHost,System.String)"> <summary> Prompt user to press a key before continuing </summary> <param name="message">Message to display</param> </member> <member name="T:NConsole.IConsoleCommand"> <summary>A command line command.</summary> </member> <member name="M:NConsole.IConsoleCommand.RunAsync(NConsole.CommandLineProcessor,NConsole.IConsoleHost)"> <summary>Runs the command.</summary> <param name="processor">The processor.</param> <param name="host">The host.</param> <returns>The output.</returns> </member> <member name="T:NConsole.IConsoleHost"> <summary>An abstraction of the command line.</summary> </member> <member name="M:NConsole.IConsoleHost.WriteMessage(System.String)"> <summary>Writes a message to the console.</summary> <param name="message">The message.</param> </member> <member name="M:NConsole.IConsoleHost.WriteError(System.String)"> <summary>Writes an error message.</summary> <param name="message">The message.</param> </member> <member name="M:NConsole.IConsoleHost.ReadValue(System.String)"> <summary>Reads a value from the console.</summary> <param name="message">The message.</param> <returns>The value.</returns> </member> <member name="P:NConsole.IConsoleHost.InteractiveMode"> <summary>Gets or sets a value indicating whether interactive mode is enabled (i.e. ReadValue() is allowed).</summary> </member> <member name="T:NConsole.IDependencyResolver"> <summary>Interface to resolve a dependency.</summary> </member> <member name="M:NConsole.IDependencyResolver.GetService(System.Type)"> <summary>Resolves the service of the given type.</summary> <param name="serviceType">Type of the service.</param> <returns></returns> </member> <member name="T:NConsole.SwitchAttribute"> <summary>Attribute to define a switch/boolean attribute.</summary> </member> <member name="P:NConsole.SwitchAttribute.ShortName"> <summary>Gets or sets the short name without the '-' prefix.</summary> </member> <member name="P:NConsole.SwitchAttribute.LongName"> <summary>Gets or sets the long name without the '--' prefix.</summary> </member> <member name="M:NConsole.SwitchAttribute.GetValue(NConsole.IConsoleHost,System.String[],System.Reflection.PropertyInfo,NConsole.IConsoleCommand,System.Object,System.String@)"> <summary>Gets the argument value.</summary> <param name="consoleHost">The command line host.</param> <param name="args">The arguments.</param> <param name="property">The property.</param> <param name="command">The command.</param> <param name="input">The output from the previous command in the chain.</param> <returns>The value.</returns> </member> </members> </doc>