New-AMDateInput

New-AMDateInput

New-AMDateInput

SYNOPSIS

Creates a Date Input element for an Adaptive Card.

SYNTAX

1

New-AMDateInput [-Id] <String> [-Label] <String> [-Value <String>] [-Placeholder <String>] [-Min <String>] [-Max <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-AMDateInput function creates an Input.Date element that allows users to select a date from a calendar interface. Date inputs are used when you need to collect a specific date from users, such as for scheduling events, setting deadlines, or specifying birthdates.

The date input supports optional default values, placeholder text, and restrictions on the selectable date range using minimum and maximum date parameters.

EXAMPLES

EXAMPLE 1

1
2
3

# Create a simple date input with default values
$dueDateInput = New-AMDateInput -Id "dueDate" -Label "Due Date:"
Add-AMElement -Card $card -Element $dueDateInput

EXAMPLE 2

1
2

# Create a date input with a specific default date
$eventDateInput = New-AMDateInput -Id "eventDate" -Label "Event Date:" -Value "2025-04-15"

EXAMPLE 3

1
2
3
4

# Create a date input with restricted date range
$birthDateInput = New-AMDateInput -Id "birthDate" -Label "Birth Date:" `
    -Placeholder "Enter your date of birth" `
    -Min "1900-01-01" -Max "2020-12-31"

EXAMPLE 4

1
2

# Create a date input with no default value
$customDateInput = New-AMDateInput -Id "customDate" -Label "Custom Date:" -Value ""

PARAMETERS

-Id

A unique identifier for the input element. This ID will be used when the card is submitted to identify the selected date value.

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

-Label

Text label to display above the input field, describing what the date selection is for.

1
2
3
4
5
6
7
8
9

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

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

-Value

Optional default date value for the input. The date should be in ISO 8601 format (YYYY-MM-DD). If not specified, defaults to the current date.

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 date has been selected. Default: “Select a date”

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

-Min

Optional minimum allowed date (inclusive) in ISO 8601 format (YYYY-MM-DD). Dates before this value will be disabled in the calendar picker.

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

-Max

Optional maximum allowed date (inclusive) in ISO 8601 format (YYYY-MM-DD). Dates after this value will be disabled in the calendar picker.

1
2
3
4
5
6
7
8
9

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

Required: False
Position: 5
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-AMDateInput.

OUTPUTS

System.Collections.Hashtable

Returns a hashtable representing the Input.Date element.

NOTES

  • Date inputs in Adaptive Cards will render differently depending on the client:
    • In most clients, they appear as a text field with a calendar picker.
    • The format of the displayed date may vary by client or user locale.
    • The value submitted will always be in ISO 8601 format (YYYY-MM-DD).
  • Ensure that the Min and Max values are valid ISO 8601 dates and that Min is earlier than Max.