Public/Actions/New-AMActionSet.ps1
|
function New-AMActionSet { <# .SYNOPSIS Creates an ActionSet element for an Adaptive Card. .DESCRIPTION The `New-AMActionSet` function generates an ActionSet element that can group multiple actions (buttons) together. ActionSets allow you to place action buttons anywhere within your card's body, not just at the bottom. This provides greater flexibility in designing your card's layout. ActionSets are particularly useful for Outlook Actionable Messages, as action buttons placed in ActionSets render better than those in the card's top-level actions property. .PARAMETER Id (Optional) A unique identifier for the ActionSet. This is useful when you need to reference or manipulate the ActionSet programmatically or with visibility toggles. .PARAMETER Actions An array of action objects to include in the ActionSet. These should be created using functions like: - `New-AMOpenUrlAction` - `New-AMSubmitAction` - `New-AMExecuteAction` - `New-AMShowCardAction` - `New-AMToggleVisibilityAction` .PARAMETER Padding (Optional) Padding value to apply around the ActionSet. Valid values include: - "None" - "Small" - "Default" - "Large" .EXAMPLE # Create a simple ActionSet with two actions $openUrlAction = New-AMOpenUrlAction -Title "Visit Website" -Url "https://example.com" $executeAction = New-AMExecuteAction -Title "Approve" -Verb "POST" -Url "https://api.example.com/approve" -Body '{"id": "12345"}' $actionSet = New-AMActionSet -Id "main-actions" -Actions @($openUrlAction, $executeAction) Add-AMElement -Card $card -Element $actionSet .EXAMPLE # Create an ActionSet with no padding containing an execute action $executeAction = New-AMExecuteAction -Title "Approve" -Verb "POST" -Url "https://api.example.com/approve" $actionSet = New-AMActionSet -Id "approval-actions" -Actions @($executeAction) -Padding "None" Add-AMElement -Card $card -Element $actionSet -ContainerId "container1" .INPUTS None. You cannot pipe input to `New-AMActionSet`. .OUTPUTS System.Collections.Hashtable Returns a hashtable representing the ActionSet element. .NOTES - ActionSets provide a way to group multiple actions together and place them anywhere within your card's body, not just at the bottom of the card. This gives you greater flexibility in designing your card's layout. - For Outlook Actionable Messages, action buttons placed in ActionSets render better than those in the card's top-level actions property. .LINK https://adaptivecards.io/explorer/ActionSet.html #> [CmdletBinding()] param ( [Parameter()] [string]$Id, [Parameter(Mandatory = $true)] [array]$Actions, [Parameter()] [string]$Padding ) # Create the ActionSet object $actionSet = [ordered]@{ 'type' = 'ActionSet' 'actions' = $Actions # Directly assign the array 'id' = $Id } # Add optional padding if ($Padding) { $actionSet.padding = $Padding } return $actionSet } |