UniqueIdentifier on Remove-BTNotification

Windos · Dec 29, 2020 · 9f06ac0 · 9f06ac0
1 parent c3a0719
commit 9f06ac0
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/BurntToast/Public/Get-BTHistory.ps1 b/BurntToast/Public/Get-BTHistory.ps1
@@ -41,6 +41,10 @@ function Get-BTHistory {
     if (!(Test-Path -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Notifications\Settings\$AppId")) {
         throw "The AppId $AppId is not present in the registry, please run New-BTAppId to avoid inconsistent Toast behaviour."
     } else {
+        if ($Script:ActionsSupported) {
+            Write-Warning -Message 'The output from this function in some versions of PowerShell is not useful. Unfortunately this is expected at this time.'
+        }
+
         $Toasts = if ($ScheduledToast) {
             [Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($AppId).GetScheduledToastNotifications()
         } else {

diff --git a/BurntToast/Public/Remove-BTNotification.ps1 b/BurntToast/Public/Remove-BTNotification.ps1
@@ -26,17 +26,25 @@ function Remove-BTNotification {
         https://github.com/Windos/BurntToast/blob/main/Help/Remove-BTNotification.md
     #>
 
-    [CmdletBinding(SupportsShouldProcess = $true,
+    [CmdletBinding(DefaultParameterSetName = 'Individual',
+                   SupportsShouldProcess = $true,
                    HelpUri = 'https://github.com/Windos/BurntToast/blob/main/Help/Remove-BTNotification.md')]
     param (
         # Specifies the AppId of the 'application' or process that spawned the toast notification.
         [string] $AppId = $Script:Config.AppId,
 
         # Specifies the tag, which identifies a given toast notification.
+        [Parameter(ParameterSetName = 'Individual')]
         [string] $Tag,
 
         # Specifies the group, which helps to identify a given toast notification.
-        [string] $Group
+        [Parameter(ParameterSetName = 'Individual')]
+        [string] $Group,
+
+        # A string that uniquely identifies a toast notification. Represents both the Tag and Group for a toast.
+        [Parameter(Mandatory = $true,
+                   ParameterSetName = 'Combo')]
+        [string] $UniqueIdentifier
     )
 
     if (!(Test-Path -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Notifications\Settings\$AppId")) {

diff --git a/CHANGES.md b/CHANGES.md
@@ -14,6 +14,8 @@
 
     - Thanks [@cedarbaum](https://github.com/cedarbaum)
 
+  - Enhancement: You can now specify a UniqueIdentifier when using the Remove-BTNotification function rather than component Tag and Group strings.
+
 - [0.8.3](https://github.com/Windos/BurntToast/releases/download/v0.8.3/BurntToast.zip)
 
   - Fix: Error when running Update-BTNotification on PowerShell 6.0+ ([#120](https://github.com/Windos/BurntToast/issues/120))