Module for creating and displaying Toast Notifications on Microsoft Windows 10.
PowerShell
Latest commit 20e97e1 Dec 31, 2016 @Windos committed on GitHub Update readme for release v0.5.1

README.md

BurntToast Logo Banner

PowerShell Module for displaying Windows 10 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 C:\Users\[User]\Documents\WindowsPowerShell\modules\BurntToast (you may have to create these directories if they don't exist.)

Examples

Default Toast

New-BurntToastNotification

BurntToast Notification Example Default

Customized Toast

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

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.

  • Bleeding Edge (Development/Raw Repo - CAUTION)
  • v0.5.1
    • Small bug fixes (thanks for opening issues!)
    • Confirmed: Now ONLY works on Windows 10
    • BurntToast now has its own, original, logo!
    • New public function to adjust function level of module: Set-BTFunctionLevel
    • Implemented checking for and registering of AppId in the registry to ensure proper Toast behaviour in the Action Center
  • v0.5.0
    • Converted to using the UWP Community Toolkit.
    • Snooze and Dismiss now available and working.
    • Documentation is out of date, this will be polished in the next release.
  • v0.4.0 - Last version that supports Windows 8
    • Credential parameter added so toasts can be generated for regular user when running PowerShell host as a different (e.g. Admin) account.
  • v0.3.0
    • Help has been added
    • Toasts can be silent with -Silent switch
    • General bug fixes
  • v0.2.0
  • v0.1.0

Contributors

TODO

License

Image Credit

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

Contact