ReplDocCommand
Command metadata.
- Kind:
Class - Namespace: Repl.Documentation
- Assembly:
Repl.Core - Source: src/Repl.Core/Documentation/ReplDocCommand.cs
Signature
Section titled “Signature”public sealed record ReplDocCommand : IEquatable<ReplDocCommand>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<ReplDocCommand>
Constructors
Section titled “Constructors”ReplDocCommand(string, string?, IReadOnlyList<string>, bool, IReadOnlyList<ReplDocArgument>, IReadOnlyList<ReplDocOption>, string?, CommandAnnotations?, IReadOnlyDictionary<string, object>?, IReadOnlyList<ReplDocAnswer>?, bool, bool, bool, bool)
Section titled “ReplDocCommand(string, string?, IReadOnlyList<string>, bool, IReadOnlyList<ReplDocArgument>, IReadOnlyList<ReplDocOption>, string?, CommandAnnotations?, IReadOnlyDictionary<string, object>?, IReadOnlyList<ReplDocAnswer>?, bool, bool, bool, bool)”Command metadata.
public ReplDocCommand(string Path, string? Description, IReadOnlyList<string> Aliases, bool IsHidden, IReadOnlyList<ReplDocArgument> Arguments, IReadOnlyList<ReplDocOption> Options, string? Details = null, CommandAnnotations? Annotations = null, IReadOnlyDictionary<string, object>? Metadata = null, IReadOnlyList<ReplDocAnswer>? Answers = null, bool IsResource = false, bool IsPrompt = false, bool AcceptsPagingInput = false, bool EmitsPagedResult = false)Parameters
Section titled “Parameters”Path(string)Description(string)Aliases(IReadOnlyList<string>)IsHidden(bool)Arguments(IReadOnlyList<ReplDocArgument>)Options(IReadOnlyList<ReplDocOption>)Details(string)Annotations(CommandAnnotations)Metadata(IReadOnlyDictionary<string, object>)Answers(IReadOnlyList<ReplDocAnswer>)IsResource(bool)IsPrompt(bool)AcceptsPagingInput(bool)EmitsPagedResult(bool)
Properties
Section titled “Properties”AcceptsPagingInput
Section titled “AcceptsPagingInput”public bool AcceptsPagingInput { get; init; }Returns
Section titled “Returns”Aliases
Section titled “Aliases”public IReadOnlyList<string> Aliases { get; init; }Returns
Section titled “Returns”IReadOnlyList<string>
Annotations
Section titled “Annotations”public CommandAnnotations? Annotations { get; init; }Returns
Section titled “Returns”Answers
Section titled “Answers”public IReadOnlyList<ReplDocAnswer>? Answers { get; init; }Returns
Section titled “Returns”IReadOnlyList<ReplDocAnswer>
Arguments
Section titled “Arguments”public IReadOnlyList<ReplDocArgument> Arguments { get; init; }Returns
Section titled “Returns”IReadOnlyList<ReplDocArgument>
Description
Section titled “Description”public string? Description { get; init; }Returns
Section titled “Returns”Details
Section titled “Details”public string? Details { get; init; }Returns
Section titled “Returns”EmitsPagedResult
Section titled “EmitsPagedResult”public bool EmitsPagedResult { get; init; }Returns
Section titled “Returns”IsHidden
Section titled “IsHidden”public bool IsHidden { get; init; }Returns
Section titled “Returns”IsPrompt
Section titled “IsPrompt”public bool IsPrompt { get; init; }Returns
Section titled “Returns”IsResource
Section titled “IsResource”public bool IsResource { get; init; }Returns
Section titled “Returns”Metadata
Section titled “Metadata”public IReadOnlyDictionary<string, object>? Metadata { get; init; }Returns
Section titled “Returns”IReadOnlyDictionary<string, object>
Options
Section titled “Options”public IReadOnlyList<ReplDocOption> Options { get; init; }Returns
Section titled “Returns”IReadOnlyList<ReplDocOption>
public string Path { get; init; }