New-AMNumberInput

New-AMNumberInput

New-AMNumberInput

SYNOPSIS

Creates a Number Input element for an Adaptive Card.

SYNTAX

1

New-AMNumberInput [-Id] <String> [-Max <String>] [-Min <String>] [-Placeholder <String>] [-Value <String>] [-Verbose <SwitchParameter>] [-Debug <SwitchParameter>] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-InformationAction <ActionPreference>] [-ProgressAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-InformationVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>] [-PipelineVariable <String>] [<CommonParameters>]

DESCRIPTION

The New-AMNumberInput function creates an Input.Number element that allows users to enter or select a numeric value. Number inputs are useful when you need to collect quantities, ratings, scores, or any other numeric data from users. The input can be configured with optional minimum and maximum values, a default value, and placeholder text.

This element ensures that only numeric values are accepted, providing a structured way to collect numeric input.

EXAMPLES

EXAMPLE 1

1
2
3

# Create a simple number input
$quantityInput = New-AMNumberInput -Id "quantity"
Add-AMElement -Card $card -Element $quantityInput

EXAMPLE 2

1
2
3

# Create a number input with range constraints
$ratingInput = New-AMNumberInput -Id "rating" `
    -Min "1" -Max "10" -Value "5" -Placeholder "Enter rating (1-10)"

EXAMPLE 3

1
2
3

# Create a quantity selector with default value
$quantityInput = New-AMNumberInput -Id "quantity" `
    -Min "1" -Max "100" -Value "1" -Placeholder "Enter quantity"

EXAMPLE 4

1
2

# Create a number input without constraints
$freeInput = New-AMNumberInput -Id "freeInput" -Placeholder "Enter any number"

PARAMETERS

-Id

A unique identifier for the input element. This ID will be used when the card is submitted to identify the numeric value entered by the user.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Max

Optional maximum allowed numeric value. Users will not be able to enter a value above this.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Min

Optional minimum allowed numeric value. Users will not be able to enter a value below this.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Placeholder

Optional text to display when no value has been entered. This helps guide users on what to input.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

Optional default numeric value for the input. If not specified, the field will be empty.

1
2
3
4
5
6
7
8
9

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None. You cannot pipe input to New-AMNumberInput.

OUTPUTS

System.Collections.Hashtable

Returns a hashtable representing the Input.Number element.

NOTES

  • Number inputs in Adaptive Cards will typically render as a text field that only accepts numeric values.
  • Some clients may show increment/decrement buttons depending on the Min and Max values provided.
  • Values are submitted as strings, so you’ll need to convert them to numeric types when processing the card data.
  • Ensure that the Min and Max values are valid numbers and that Min is less than or equal to Max.