New-AMShowCardAction

New-AMShowCardAction

New-AMShowCardAction

SYNOPSIS

Creates a ShowCard Action for an Adaptive Card.

SYNTAX

1

New-AMShowCardAction [-Title] <String> [-Id <String>] [-Card <Hashtable>] [-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-AMShowCardAction function generates an Action.ShowCard element for an Adaptive Card. This action reveals a nested card when the button is clicked. It is useful for progressive disclosure of information, such as showing additional details, forms, or content without navigating away from the current view or requiring another HTTP request.

If no card is provided, a default empty card will be created with basic properties.

EXAMPLES

EXAMPLE 1

1
2

# Create a ShowCard action with an empty card
$showAction = New-AMShowCardAction -Title "Show Details"

EXAMPLE 2

1
2
3
4

# Create a ShowCard action with a pre-configured card
$detailCard = New-AMCard -OriginatorId "nested-card"
Add-AMElement -Card $detailCard -Element (New-AMTextBlock -Text "These are additional details" -Wrap $true)
$showAction = New-AMShowCardAction -Title "Show Details" -Card $detailCard

EXAMPLE 3

1
2
3
4

# Create a ShowCard action with a form inside
$feedbackCard = New-AMCard -OriginatorId "feedback-card"
Add-AMElement -Card $feedbackCard -Element (New-AMTextBlock -Text "Please provide your feedback:")
Add-AMElement -Card $feedbackCard -Element (New-AMTextInput -Id "comments" -Placeholder "Type your comments here" -IsMultiline $true)

Example explanation

1
2
3
4
5
6

# Create a submit button for the nested card
$submitAction = New-AMSubmitAction -Title "Submit Feedback" -Data @{ action = "feedback" }
$actionSet = New-AMActionSet -Actions @($submitAction)
Add-AMElement -Card $feedbackCard -Element $actionSet

$feedbackAction = New-AMShowCardAction -Title "Provide Feedback" -Id "feedback-form" -Card $feedbackCard

PARAMETERS

-Title

The text to display on the action button that will reveal the card.

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

-Id

(Optional) A unique identifier for the action. If not specified, a new GUID will be generated automatically. The ID can be useful when referencing this action programmatically or from other parts of your card.

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

-Card

(Optional) A pre-configured card to show when the button is clicked. If not provided, an empty card with default properties will be created.

1
2
3
4
5
6
7
8
9

Type: Collections.Hashtable
Parameter Sets: (All)
Aliases: None

Required: False
Position: 2
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-AMShowCardAction.

OUTPUTS

System.Collections.Hashtable

Returns a hashtable representing the Action.ShowCard element.

NOTES

  • Action.ShowCard is ideal for scenarios where you want to reveal additional information or forms without requiring a new HTTP request or navigating away from the current card.
  • If no card is provided, a default empty card will be created with basic properties.
  • Nested cards created with Action.ShowCard are rendered inline within the parent card.