New-AMToggleInput

New-AMToggleInput

New-AMToggleInput

SYNOPSIS

Creates a Toggle Input element for an Adaptive Card.

SYNTAX

1

New-AMToggleInput [-id <String>] [-title <String>] [-value <String>] [-valueOn <String>] [-valueOff <String>] [-style <String>] [<CommonParameters>]

DESCRIPTION

Creates an Input.Toggle element that allows users to switch between two states: on or off. Toggle inputs are useful for boolean choices, preferences, or any yes/no decision.

The element typically renders as a checkbox or toggle switch depending on the host application, making it ideal for settings, confirmations, or agreement inputs.

EXAMPLES

EXAMPLE 1

1
2
3

# Create a simple toggle for agreement
$agreementToggle = New-AMToggleInput -id "termsAgreed" -title "I agree to the terms and conditions"
Add-AMElement -Card $card -Element $agreementToggle

EXAMPLE 2

1
2
3

# Create a toggle with custom values
$notificationToggle = New-AMToggleInput -id "notifications" -title "Enable notifications" `
    -value $true -valueOn "enabled" -valueOff "disabled"

EXAMPLE 3

1
2

# Create multiple toggles for settings
$card = New-AMCard -OriginatorId "preferences-app"

Example explanation

1
2
3
4
5
6
7
8
9
10

$settingsContainer = New-AMContainer -Id "settings" -Style "emphasis"
Add-AMElement -Card $card -Element $settingsContainer

$emailToggle = New-AMToggleInput -id "emailAlerts" -title "Email notifications" -value $true
$smsToggle = New-AMToggleInput -id "smsAlerts" -title "SMS notifications" -value $false
$weeklyToggle = New-AMToggleInput -id "weeklyDigest" -title "Weekly summary report" -value $true

Add-AMElement -Card $card -Element $emailToggle -ContainerId "settings"
Add-AMElement -Card $card -Element $smsToggle -ContainerId "settings"
Add-AMElement -Card $card -Element $weeklyToggle -ContainerId "settings"

PARAMETERS

-id

A unique identifier for the toggle input element. This ID will be used when the card is submitted to identify the toggle’s state.

1
2
3
4
5
6
7
8
9

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

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

-title

The text label displayed next to the toggle control. This describes what the toggle represents or controls.

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

-value

The initial state of the toggle.

  • $true or “true”: The toggle is initially on/checked
  • $false or “false”: The toggle is initially off/unchecked Default: $false
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

-valueOn

Optional text value to submit when the toggle is in the “on” state. Default: “true”

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

-valueOff

Optional text value to submit when the toggle is in the “off” state. Default: “false”

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

-style

Optional visual style for the toggle input. Valid values: “default”, “expanded”, “compact” Default: “default”

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-AMToggleInput.

OUTPUTS

System.Collections.Hashtable

Returns a hashtable representing the Input.Toggle element.

NOTES

Toggle inputs are ideal for binary choices where the user must select one of two options.

When designing forms with toggles:

  • Use clear, concise labels that indicate the “on” state
  • Consider grouping related toggles together
  • For more complex choices with multiple options, consider using ChoiceSet instead