Watch Aspire live streamsDocsTry Aspire
Watch Aspire live streamsDocsTry

InteractionInput Properties

ClassProperties17 members
Represents an input for an interaction.
Gets a value indicating whether a custom choice is allowed. Only used by InputType.Choice inputs.
public bool AllowCustomChoice { get; init; }
AllowMultipleFilesSection titled AllowMultipleFilesbool
Gets or sets a value indicating whether multiple files can be selected. Only used by InputType.File inputs.
public bool AllowMultipleFiles { get; init; }
DescriptionSection titled Descriptionnullablestring?
Gets or sets the description for the input.
public string? Description { get; init; }
Gets or sets a value indicating whether the input is disabled.
public bool Disabled { get; set; }
Gets the InputLoadOptions for the input. Dynamic loading is used to load data and update inputs after a prompt has started. It can also be used to reload data and update inputs after a dependant input has changed.
public InputLoadOptions? DynamicLoading { get; init; }
EnableDescriptionMarkdownSection titled EnableDescriptionMarkdownbool
Gets or sets a value indicating whether the description should be rendered as Markdown. Setting this to true allows a description to contain Markdown elements such as links, text decoration and lists.
public bool EnableDescriptionMarkdown { get; init; }
FileFilterSection titled FileFilternullablestring?
Gets or sets the file type filter for InputType.File inputs. Uses the same format as the HTML accept attribute, e.g. ".pem,.pfx,.crt" or "image/*". When set, the file picker restricts selectable files. The CLI validates only dot-prefixed extension filters and does not validate MIME type patterns such as "image/*".
public string? FileFilter { get; init; }
Gets the files associated with this InputType.File input. Populated after the user selects file(s) and the interaction completes.
public IReadOnlyList<InteractionFile>? Files { get; }
Gets or sets the type of the input.
public InputType InputType { get; init; }
LabelSection titled Labelnullablestring?
Gets or sets the label for the input. If not specified, the name will be used as the label.
public string? Label { get; init; }
MaxFileSizeSection titled MaxFileSizenullablelong?
Gets or sets the maximum file size in bytes for InputType.File inputs. If not specified, the server applies the configured upload limit (default 100 MB). When specified, the value is capped at the server-side upload limit.
public long? MaxFileSize { get; init; }
MaxLengthSection titled MaxLengthnullableint?
gets or sets the maximum length for text inputs.
public int? MaxLength { get; init; }
Gets or sets the name for the input. Used for accessing inputs by name from a keyed collection.
public string Name { get; init; }
OptionsSection titled OptionsnullableIReadOnlyList<KeyValuePair<string, string>>
Gets or sets the options for the input. Only used by InputType.Choice inputs.
public IReadOnlyList<KeyValuePair<string, string>>? Options { get; set; }
PlaceholderSection titled Placeholdernullablestring?
Gets the placeholder text for the input.
public string? Placeholder { get; init; }
Gets or sets a value indicating whether the input is required.
public bool Required { get; init; }
ValueSection titled Valuenullablestring?
Gets or sets the value of the input.
public string? Value { get; set; }