Skip to content
main
Go to file
Code

README.md

BurntToast

Codacy Badge codecov Build Status PowerShell Gallery Version PowerShell Gallery Downloads Open Issues

BurntToast Logo Banner

PowerShell Module for displaying Windows 10 and Windows Server 2019 Toast Notifications

Install

PowerShell Gallery Install (Requires PowerShell v5)

    Install-Module -Name BurntToast

See the PowerShell Gallery for the complete details and instructions.

Manual Install

Download BurntToast.zip and extract the contents into $env:userprofile\Documents\WindowsPowerShell\modules\BurntToast (you may have to create these directories if they don't exist.)

if you using Powershell 6 or later, extract into $env:userprofile\Documents\PowerShell\Modules\BurntToast

Please remember to "unblock" the zip file before extracting the contents. Not doing so will result in the module not working correctly. This can be done via the file properties or with Unblock-File.

Examples

Default Toast

    New-BurntToastNotification

BurntToast Notification Example Default

Customized Toast

    New-BurntToastNotification -AppLogo C:\smile.jpg -Text "Don't forget to smile!",
                                                           'Your script ran successfully, celebrate!'

BurntToast Notification Example Custom

Alarm Clock

    New-BurntToastNotification -Text 'WAKE UP!' -Sound 'Alarm2' -SnoozeAndDismiss

BurntToast Notification Example Alarm

Releases

Please note: as of v0.5.0, BurntToast no longer works on Windows 8.

  • 0.8.3

    • Fix: Error when running Update-BTNotification on PowerShell 6.0+ (#120)

    • Fix: Error when using actionable toast parameters on any version (#122)

    • Fix: Multiple warnings about events not being supported when specifying multiple event types.

  • v0.8.2

    • Add: AdaptiveGroups are now usable via New-BTColumn
  • v0.8.1

    • Fix: Toast alias removed in 0.8.0 has been restored

    • Deprecation: Signalling removal of Shoulder Tap cmdlets in future version, v0.9.0

    • Deprecation: Signalling removal of Path parameter from New-BTAudio in future version, v0.9.0.

  • v0.8.0

    • Fix: Images from UNC path failing (#111)

    • Add: Ability to force a refresh of cached images via IgnoreCache switch on New-BTImage

    • Add: ACTIONABLE NOTIFICATIONS! Exposed via ActivatedAction and DismissedAction parameters on Submit-BTNotification and New-BurntToastNotification

  • v0.7.2

    • Fix: Curly Braces when "Reminder" pops up (#72)

    • Fix: Caching remote gifs are saved based on their remote filename and not overwritten (#105)

    • Fix: BurntToast and .NET 5 (#101)

  • v0.7.1

    • Update: Microsoft Community Toolkit to 6.0.0

    • New: Support relative paths on images

    • New: "ScheduledToast" switch added to Get-BTHistory which returns scheduled or snoozed toast notifications

    • Enhancement: Libraries only loaded on module import if libraries not already loaded

    • Enhancement: Validate that image paths exist

    • Fix: Reverted to XML clean up to remove curly braces if databindings are not being used (Issue #72)

    • Known Issues:

      • Regardless of what snooze option is chosen, a snoozed toast will re-appear after 9 minutes
      • Cause is unknown and isn''t unique to v0.7.1, will be investigated while working on v0.7.2
  • see more in the Full Change Log

Contributors

License

Image Credit

The default image for BurntToast Notifications is a photo taken by Craig Sunter

Contact

You can’t perform that action at this time.